# sdir
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n sdir --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install sdir
```
### nbdev
``` sh
# activate conda environment
$ conda activate sdir
# make sure the sdir package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the sdir package
$ nbdev_prepare
```
### Publishing
``` sh
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'
```
# Usage
## Installation
Install latest from the GitHub
[repository](https://github.com/dsm-72/sdir):
``` sh
$ pip install git+https://github.com/dsm-72/sdir.git
```
or from [conda](https://anaconda.org/dsm-72/sdir)
``` sh
$ conda install -c dsm-72 sdir
```
or from [pypi](https://pypi.org/project/sdir/)
``` sh
$ pip install sdir
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/sdir)
[pages](https://dsm-72.github.io/sdir/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/sdir) and
[pypi](https://pypi.org/project/sdir/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/verx",
"name": "verx",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/b6/f7/2eff1a5435e748357d10139fd93ebc8e7d3455ed5f63df36f209eedb1128/verx-0.0.1.tar.gz",
"platform": null,
"description": "# sdir\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\n### Setup\n\n``` sh\n# create conda environment\n$ mamba env create -f env.yml\n\n# update conda environment\n$ mamba env update -n sdir --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install sdir\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate sdir\n\n# make sure the sdir package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to the sdir package\n$ nbdev_prepare\n```\n\n### Publishing\n\n``` sh\n# publish to pypi\n$ nbdev_pypi\n\n# publish to conda\n$ nbdev_conda --build_args '-c conda-forge'\n$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/sdir):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/sdir.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/sdir)\n\n``` sh\n$ conda install -c dsm-72 sdir\n```\n\nor from [pypi](https://pypi.org/project/sdir/)\n\n``` sh\n$ pip install sdir\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/sdir)\n[pages](https://dsm-72.github.io/sdir/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/sdir) and\n[pypi](https://pypi.org/project/sdir/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "version extra version ver verx",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/dsm-72/verx"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6274c2daf69e797f2e6d3f9b73dd80daa888235bb4cdd4b645de809557dab829",
"md5": "f4248a74303519abc9a14bc0493bde95",
"sha256": "a93d0ac8fe1c7bb70a14f50753f2b8f32ad0c1b2a03fb0aa2b2b09c9c4800e3c"
},
"downloads": -1,
"filename": "verx-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4248a74303519abc9a14bc0493bde95",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9310,
"upload_time": "2023-10-22T18:26:32",
"upload_time_iso_8601": "2023-10-22T18:26:32.526261Z",
"url": "https://files.pythonhosted.org/packages/62/74/c2daf69e797f2e6d3f9b73dd80daa888235bb4cdd4b645de809557dab829/verx-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6f72eff1a5435e748357d10139fd93ebc8e7d3455ed5f63df36f209eedb1128",
"md5": "e2d0f4257eb092322e7a7afc2f64ded0",
"sha256": "2548a5bdb8af47bfcd42327964605d773236b5cf8f91666a27776927c5f97f9f"
},
"downloads": -1,
"filename": "verx-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e2d0f4257eb092322e7a7afc2f64ded0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9435,
"upload_time": "2023-10-22T18:26:33",
"upload_time_iso_8601": "2023-10-22T18:26:33.710692Z",
"url": "https://files.pythonhosted.org/packages/b6/f7/2eff1a5435e748357d10139fd93ebc8e7d3455ed5f63df36f209eedb1128/verx-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-22 18:26:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "verx",
"github_not_found": true,
"lcname": "verx"
}
JSON
