diff --git a/README.md b/README.md index a4b2c7e..12c4992 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ i.e. discretized geomatrical surfaces on the unit sphere. MOC Lib Rust, the Rust MOC library used in [MOCPy](https://github.com/cds-astro/mocpy), -[MOCli](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/cli), and +[MOCli](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/cli), [MOCSet](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/set), and [MOCWasm](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/wasm). @@ -21,11 +21,13 @@ MOC Lib Rust rely on the [CDS HEALPix Rust library](https://github.com/cds-astro ## About This Rust library implements the v2.0 of the [MOC standard](https://ivoa.net/documents/MOC/), -including (S-)MOCs, T-MOCs and ST-MOCs. +including (S-)MOCs, T-MOCs and ST-MOCs. +It also implements a still experimental F-MOC (F for Frequency). -It is used in: +MOC Lib Rust is used in: * [MOCPy](https://github.com/cds-astro/mocpy), a Python wrapper to manipulate MOCs; * a standalone command line tool [MOCli](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/cli) for linux, MacOS and Windows; +* a standalone command line tool [MOCSet](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/set) for linux, MacOS and Windows; * a WASM library [MOCWasm](https://github.com/cds-astro/cds-moc-rust/tree/main/crates/wasm) to be used in web browsers. For tools able to display MOCs, see: diff --git a/crates/cli/README.md b/crates/cli/README.md index 01ac0cb..c8c689b 100644 --- a/crates/cli/README.md +++ b/crates/cli/README.md @@ -351,6 +351,7 @@ time moc filter position SMOC_GLIMPSE_u32.fits kids_dr2.csv --has-header --lon R ## To-do list +* [ ] Remove `structop` and replace by `clap v3` * [ ] MOC from cells (simpler than MOC from pos) * [ ] MOC from vcells with a simple constraint? * [ ] Contact [gnuastro](https://www.gnu.org/software/gnuastro) ? diff --git a/crates/set/Cargo.toml b/crates/set/Cargo.toml index 41e8740..24b4d16 100644 --- a/crates/set/Cargo.toml +++ b/crates/set/Cargo.toml @@ -36,18 +36,18 @@ depends = "$auto" section = "utility" priority = "optional" assets = [ - ["target/release/moc", "usr/bin/mocset", "755"], + ["target/release/mocset", "usr/bin/mocset", "755"], ["COPYING", "usr/share/doc/mocset/", "644"], ["LICENSE-MIT", "usr/share/doc/mocset/", "644"], ["LICENSE-APACHE", "usr/share/doc/mocset/", "644"], ["CHANGELOG.md", "usr/share/doc/mocset/CHANGELOG", "644"], ["README.md", "usr/share/doc/mocset/README", "644"], - #["FAQ.md", "usr/share/doc/moc/FAQ", "644"], - ["doc/moc.1", "usr/share/man/man1/mocset.1", "644"], + #["FAQ.md", "usr/share/doc/mocset/FAQ", "644"], + ["doc/mocset.1", "usr/share/man/man1/mocset.1", "644"], # Similarly for shell completions. - #["deployment/deb/moc.bash", "usr/share/bash-completion/completions/moc", "644"], - #["deployment/deb/moc.fish", "usr/share/fish/vendor_completions.d/moc.fish", "644"], - #["deployment/deb/_moc", "usr/share/zsh/vendor-completions/", "644"], + #["deployment/deb/mocset.bash", "usr/share/bash-completion/completions/mocset", "644"], + #["deployment/deb/mocset.fish", "usr/share/fish/vendor_completions.d/mocset.fish", "644"], + #["deployment/deb/_mocset", "usr/share/zsh/vendor-completions/", "644"], ] extended-description = """\ mocset is a command-line to query a set of MOCs pre-saved in a single large binary file. diff --git a/crates/set/doc/mocset.1.txt.tpl b/crates/set/doc/mocset.1.txt.tpl new file mode 100644 index 0000000..4fd8e33 --- /dev/null +++ b/crates/set/doc/mocset.1.txt.tpl @@ -0,0 +1,95 @@ +mocset(1) +========= + +Name +---- +mocset - query a set of HEALPix Multi-Order Coverages map (MOC) pre-saved in a +single large binary file. The file can be seen as a persistent cache preventing +from having to open/read/parse a possible large set of FITS files. + + +Synopsis +-------- + +*mocset* _SUBCMD_ _SUBCMDPARAMS_ + +*mocset* _SUBCMD_ *--help* + +*mocset* *--version* + +*command* | *mocset* query MOCSET_FILE moc - --format [ascii|json] + + +SUBCMD +------ +_make_:: + Make a new mocset + +_list_:: + Provide the list of the MOCs in a mocset and the associated flags + +_query_:: + Query a mocset + +_chgstatus_:: + Change the status flag of the given MOCs identifiers (valid, + deprecated, removed) + +_append_:: + Append the given MOCs to an existing mocset + +_purge_:: + Purge the mocset removing physically the MOCs flagged as 'removed' + +_extract_:: + Extracts a MOC from the given moc-set + +Examples +-------- + +mocset make --n128 3 --moc-list moclist.txt --delimiter , mocset.bin + +mocset list mocset.bin + +mocset query moclist.bin pos 90.0 +0.0 + +mocset query mocset.bin cone 90.0 +0.0 320.0 --precision 5 + +mocset query mocset.bin moc YOUR_PATH/CDS_IX_59_xmm4dr9s.fits + +moc from polygon 5 "(0.0,0.0),(10.0,0.0),(0.0,10.0)" ascii | mocset query mocset.bin moc - --format ascii + +mocset chgstatus mocset.bin 1 deprecated + +mocset chgstatus mocset.bin 1 valid + +mocset chgstatus mocset.bin 1 removed + +mocset append mocset.bin 3000 MY_PATH/my_new_moc.fits + +mocset purge mocset.bin + + + +DESCRIPTION +----------- + + + +VERSION +------- +{VERSION} + + +HOMEPAGE +-------- +https://github.com/cds-astro/moc + +Please report bugs and feature requests in the issue tracker. + + +AUTHORS +------- +F.-X. Pineau + +