Skip to content

Commit d032a6f

Browse files
committed
updating readme
1 parent a073697 commit d032a6f

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ or, to have a local copy on your machine, clone and install as an editable packa
2121
```
2222
git clone https://www.github.com/sdss/explorer.git ./sdss-explorer
2323
cd sdss-explorer
24-
pip install -e .
24+
pip install -e .
2525
```
2626

2727
These instructions are the same as in `conda`.
@@ -49,14 +49,29 @@ pip install -e .
4949

5050

5151
### Data files
52-
Explorer uses stacked, custom HDF5 renders of the [astra](https://github.com/sdss/astra) summary files for each data release. You can download the HDF5's from [here](https://data.sdss5.org/sas/sdsswork/users/u6054929/). These are proprietary SDSS data files, and should not be shared outside the collaboration.
52+
Explorer uses stacked, custom HDF5 renders of the [astra](https://github.com/sdss/astra) summary files for each data release. You can download the HDF5's from [here](https://data.sdss5.org/sas/sas/sdsswork/sandbox/data-viz/explorer/). These are proprietary SDSS data files, and should not be shared outside the collaboration.
5353

5454
It additionally uses a custom parquet render of the mappings used in [semaphore](https://github.com/sdss/semaphore), available in the same directory.
5555

56+
### Generating New Data Files
57+
58+
New datafiles for the dashboard must be generated each time the source SDSS summary catalog files change, as well as for each new Data Release. The files should be located [here](https://data.sdss5.org/sas/sas/sdsswork/sandbox/data-viz/explorer/) with the following structure:
59+
60+
- **(release)**: a directory for each data release
61+
- **columnsAll(Star|Visit)-`(astra_version)`.json**: JSON files providing a list of all columns for each catalog file used in the dashboard. One file per star/visit catalogs.
62+
- **explorerAll(Star|Visit)-`(astra_version)`.hdf5**: HDF5 files of the summary catalogs aggregated into a single file. One file per star/visit catalogs.
63+
- **ipl3_partial.json**: a JSON of the datamodel column descriptions of the catalog summary files, used for populating the dashboard column glossary.
64+
- **mappings.parquet**: compiled datafile of all the sdss targeting cartons and programs
65+
- **explorer**: a directory used as a scratch space for user's downloading subsets via the dashboard.
66+
67+
New `columnsXXX.json` and `explorerXXX.hdf5` files are generated following instructions at https://github.com/sdss/explorer-filegen. Also see the docs at [Explorer Dev DataFiles](https://sdss.github.io/explorer/developer/datafiles/).
68+
69+
`ipl3_partial.json` contains, for each datamodel column name, the following fields: `name`, `description`, `type`, `unit`.
70+
5671
## Starting the server
5772
To run, the environment variables must be exported to the shell environment. The base ones are:
5873

59-
- `EXPLORER_DATAPATH` :: path to data files (proprietary SDSS data, found on the SAS).
74+
- `EXPLORER_DATAPATH` :: path to data files (proprietary SDSS data, found on the SAS).
6075
- In the deployment context a folder is mounted onto the VM.
6176
- Files are expected to be placed as: `./[release]/[explorer|columns]All[datatype]-[vastra].[hdf5|parquet]`
6277
- `VASTRA` :: specific [astra](https://github.com/sdss/astra) reduction versions to read.
@@ -97,7 +112,7 @@ uvicorn --reload sdss_explorer.server:app --port=8050
97112
This will start _purely_ the app in development refresh mode on two uvicorn instances. To run in production mode, add `--production` to the `solara` command, and remove the `--reload` flag from the `uvicorn` call.
98113

99114
### Docker
100-
This repo comes included with a basic production docker image. This docker image deploys **only** the dashboard "download server", a lightweight FastAPI server to handle downloading data subsets from the UI dashboard.
115+
This repo comes included with a basic production docker image. This docker image deploys **only** the dashboard "download server", a lightweight FastAPI server to handle downloading data subsets from the UI dashboard.
101116

102117
To build, run:
103118
```bash

0 commit comments

Comments
 (0)