# tree
[](https://sdss-tree.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/sdss/tree/actions/workflows/sphinxbuild.yml)
[](https://github.com/sdss/tree/actions/workflows/build.yml)
[](https://codecov.io/gh/sdss/tree)
This product contains the definition(s) of the SDSS Science Archiver Server (SAS) filesystem environment tree(s). It
sets up the SDSS environment configuration files for loading either via the [Modules Environment Manager](http://modules.sourceforge.net/) or dynamically with a ``tree.Tree`` python package. Available environments are a SDSS "working" environment, i.e. ``sdsswork`` or any number of environments for public Data
Releases, i.e. ``dr16.cfg``. See full documentation at http://sdss-tree.readthedocs.io/en/latest/.
## Developer Install
### Local Install
To install tree for development locally:
```
git clone https://github.com/sdss/tree
cd tree
pip install -e ".[dev,docs]"
```
### Install at Utah
To install at Utah for use with modules,
```
git clone https://github.com/sdss/tree main
cd main
python bin/setup_tree.py -v
```
Replace `main` with the desired branch or tag name as needed. Also, see the instructions on the [Wiki](https://wiki.sdss.org/display/DATA/tree#tree-InstallationofthetreeproductatUtah)
### Install as a Dependency
To install as a Python package dedendency for software use, install the latest tag straight from PyPi:
```
pip install sdss-tree
```
## Build Sphinx Docs
Within the top level repo directory, run the `sdsstools` commands:
```
# build the Sphinx documentation
sdss docs.build
# open the docs locally in a browser
sdss docs.show
```
Documentation is automatically built and pushed to Read The Docs.
## Testing
Tests are created using `pytest`. Navigate to the `tests` directory from the top level and run with `pytest`.
```
cd tests
pytest
```
## Creating Releases
New releases of `sdss-tree` are created automatically, and pushed to [PyPi](https://pypi.org/project/sdss-tree/), when new tags are pushed to Github. See the [Create Release](.github/workflows/release.yml) Github Action and [Releases](https://github.com/sdss/tree/releases) for the list.
New tag names follow the Python semantic versioning syntax, i.e. `X.Y.Z`.
## Useful links
- GitHub: https://github.com/sdss/tree
- Documentation: https://sdss-tree.readthedocs.org
- Issues: https://github.com/sdss/tree/issues
Raw data
{
"_id": null,
"home_page": "https://github.com/sdss/tree",
"name": "sdss-tree",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "astronomy,software",
"author": "Brian Cherinka",
"author_email": "bcherinka@stsci.edu",
"download_url": "https://files.pythonhosted.org/packages/0f/85/aa94fc32c058b9624c89072264e9d9105beb0f0d431a2a6f04faeb3bf0e5/sdss-tree-4.0.6.tar.gz",
"platform": null,
"description": "# tree\n\n\n[](https://sdss-tree.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/sdss/tree/actions/workflows/sphinxbuild.yml)\n[](https://github.com/sdss/tree/actions/workflows/build.yml)\n[](https://codecov.io/gh/sdss/tree)\n\nThis product contains the definition(s) of the SDSS Science Archiver Server (SAS) filesystem environment tree(s). It\nsets up the SDSS environment configuration files for loading either via the [Modules Environment Manager](http://modules.sourceforge.net/) or dynamically with a ``tree.Tree`` python package. Available environments are a SDSS \"working\" environment, i.e. ``sdsswork`` or any number of environments for public Data\nReleases, i.e. ``dr16.cfg``. See full documentation at http://sdss-tree.readthedocs.io/en/latest/.\n\n\n## Developer Install\n\n### Local Install\n\nTo install tree for development locally:\n\n```\ngit clone https://github.com/sdss/tree\ncd tree\npip install -e \".[dev,docs]\"\n```\n\n### Install at Utah\n\nTo install at Utah for use with modules,\n```\ngit clone https://github.com/sdss/tree main\ncd main\npython bin/setup_tree.py -v\n```\nReplace `main` with the desired branch or tag name as needed. Also, see the instructions on the [Wiki](https://wiki.sdss.org/display/DATA/tree#tree-InstallationofthetreeproductatUtah)\n\n### Install as a Dependency\n\nTo install as a Python package dedendency for software use, install the latest tag straight from PyPi:\n```\npip install sdss-tree\n```\n\n## Build Sphinx Docs\n\nWithin the top level repo directory, run the `sdsstools` commands:\n```\n# build the Sphinx documentation\nsdss docs.build\n\n# open the docs locally in a browser\nsdss docs.show\n```\nDocumentation is automatically built and pushed to Read The Docs.\n\n## Testing\nTests are created using `pytest`. Navigate to the `tests` directory from the top level and run with `pytest`.\n```\ncd tests\npytest\n```\n\n## Creating Releases\n\nNew releases of `sdss-tree` are created automatically, and pushed to [PyPi](https://pypi.org/project/sdss-tree/), when new tags are pushed to Github. See the [Create Release](.github/workflows/release.yml) Github Action and [Releases](https://github.com/sdss/tree/releases) for the list.\n\nNew tag names follow the Python semantic versioning syntax, i.e. `X.Y.Z`.\n\n\n## Useful links\n\n- GitHub: https://github.com/sdss/tree\n- Documentation: https://sdss-tree.readthedocs.org\n- Issues: https://github.com/sdss/tree/issues\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Control and setup of SDSS tree environment and modules",
"version": "4.0.6",
"project_urls": {
"Documentation": "https://sdss-tree.readthedocs.org",
"Homepage": "https://github.com/sdss/tree",
"Repository": "https://github.com/sdss/tree"
},
"split_keywords": [
"astronomy",
"software"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afec6f804f72990f0d2691e5a91074ac465ce2973dec8f590087cdf2c698f25b",
"md5": "fd8d8926e25f8d5bc0bfab24b50cb04c",
"sha256": "1035517366d12b801596c46670f21b458c7334c3ee896313d1628c90529a2814"
},
"downloads": -1,
"filename": "sdss_tree-4.0.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd8d8926e25f8d5bc0bfab24b50cb04c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 53742,
"upload_time": "2024-03-08T18:38:29",
"upload_time_iso_8601": "2024-03-08T18:38:29.499981Z",
"url": "https://files.pythonhosted.org/packages/af/ec/6f804f72990f0d2691e5a91074ac465ce2973dec8f590087cdf2c698f25b/sdss_tree-4.0.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f85aa94fc32c058b9624c89072264e9d9105beb0f0d431a2a6f04faeb3bf0e5",
"md5": "6540ec29d6c7a0870fe89cd6351d1590",
"sha256": "4532f19099d39912fb5c725996fbc874367df51faf239a9cb0156badb1d64a86"
},
"downloads": -1,
"filename": "sdss-tree-4.0.6.tar.gz",
"has_sig": false,
"md5_digest": "6540ec29d6c7a0870fe89cd6351d1590",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 42083,
"upload_time": "2024-03-08T18:38:31",
"upload_time_iso_8601": "2024-03-08T18:38:31.653664Z",
"url": "https://files.pythonhosted.org/packages/0f/85/aa94fc32c058b9624c89072264e9d9105beb0f0d431a2a6f04faeb3bf0e5/sdss-tree-4.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 18:38:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sdss",
"github_project": "tree",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "sdss-tree"
}
JSON
