|
1 | 1 | # desc-python |
2 | | -Collection of DESC python environments and jupyter kernels for use with JupyterLab at NERSC |
| 2 | +Collection of DESC python environments and jupyter kernels |
3 | 3 |
|
4 | 4 | ## Setup for use on the Command line |
5 | 5 | NERSC: ```source/global/common/software/lsst/common/miniconda/setup_current_python.sh``` |
6 | 6 |
|
7 | 7 | CC: ```source /pbs/throng/lsst/software/desc/common/miniconda/setup_current_python.sh``` |
8 | 8 |
|
9 | | -## [How to Add User Installed Packages](https://github.com/LSSTDESC/desc-python/wiki/Add-Your-Own-Packages-to-the-desc-python-Environment) |
| 9 | +## [How to Add User Installed Packages To Your Environment](https://github.com/LSSTDESC/desc-python/wiki/Add-Packages-to-the-desc-python-environment) |
10 | 10 |
|
11 | 11 | ## Initial User setup for Jupyter (Only need to do this once) |
12 | 12 | See: https://confluence.slac.stanford.edu/display/LSSTDESC/Using+Jupyter+at+NERSC (Confluence log-in required) |
13 | 13 |
|
14 | | -## Current Jupyter Kernels |
| 14 | +### Current Jupyter Kernels |
15 | 15 | - desc-python: Current producution release including all DESC requested packages |
16 | 16 | - desc-python-dev: Upcoming production release of desc-python |
17 | 17 | - desc-python-bleed: Picks up latest releases of all python packages. Updated weekly |
18 | 18 | - desc-python-old: Previous production release of desc-python |
19 | 19 |
|
20 | 20 | ## List of Packages Included in the desc-python Environment |
21 | | -See: [desc-python-env.yml](https://github.com/LSSTDESC/desc-python/blob/master/conda/desc-python-env.yml) |
| 21 | +[conda packages](https://github.com/LSSTDESC/desc-python/blob/main/conda/conda-pack.txt) |
22 | 22 |
|
| 23 | +[pip installed packages](https://github.com/LSSTDESC/desc-python/blob/main/conda/pip-pack.txt) |
23 | 24 |
|
| 25 | +## How to Add Packages to desc-python? |
24 | 26 |
|
25 | | -## desc-python Releases |
| 27 | +1. Clone this repo and checkout the "bleed" branch |
| 28 | +2. Add new package names to the `desc-python/conda/conda-pack.txt` (for conda-forge) or `desc-pythonv/conda/pip-pack.txt` (for PyPI) |
| 29 | + * If this package is not installable from conda-forge or pip, please [open an issue](https://github.com/LSSTDESC/desc-python/issues) on this repository. |
| 30 | +3. Commit and push your changes to the bleed branch |
| 31 | +4. Once changes are pushed to the bleed branch an automated builds will be triggered: |
| 32 | + * Docker builds are handled by GitHub actions and will be triggered immediately. The builds can be followed by viewing the [Actions](https://github.com/LSSTDESC/desc-python/actions) page. |
| 33 | + * A successful build will produce a new image available on [Dockerhub](https://hub.docker.com/r/lsstdesc/desc-python/tags): `lsstdesc/desc-python:bleed` |
| 34 | + 5. If there are data files or set up commands needed for the new package, then please [open an issue](https://github.com/LSSTDESC/desc-python/issues) on this repository. |
26 | 35 |
|
27 | | -### First Run2.2i python env |
28 | | -`/global/common/software/lsst/common/miniconda/py3.7-4.7.12.1` |
29 | | - |
30 | | -### Final Run2.1i python env |
31 | | -`/global/common/software/lsst/common/miniconda/py3-4.5.12` |
32 | | - |
33 | | -Set up using `source /global/common/software/lsst/common/miniconda/setup_current_python.sh` |
34 | | - |
35 | | -### Final Run1.2i python env |
36 | | -`/global/common/software/lsst/common/miniconda/py3-4.5.4` |
0 commit comments