# sigr
<!-- 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 sigr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install sigr
```
### nbdev
``` sh
# activate conda environment
$ conda activate sigr
# make sure the sigr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the sigr 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/sigr):
``` sh
$ pip install git+https://github.com/dsm-72/sigr.git
```
or from [conda](https://anaconda.org/dsm-72/sigr)
``` sh
$ conda install -c dsm-72 sigr
```
or from [pypi](https://pypi.org/project/sigr/)
``` sh
$ pip install sigr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/sigr)
[pages](https://dsm-72.github.io/sigr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/sigr) and
[pypi](https://pypi.org/project/sigr/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/sigr",
"name": "sigr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "sigr",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/da/1f/75a908bb753593daf0e3db9196063f4d37f825ee0a5bea9f461b8a776325/sigr-0.0.12.tar.gz",
"platform": null,
"description": "# sigr\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 sigr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install sigr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate sigr\n\n# make sure the sigr 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 sigr 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/sigr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/sigr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/sigr)\n\n``` sh\n$ conda install -c dsm-72 sigr\n```\n\nor from [pypi](https://pypi.org/project/sigr/)\n\n``` sh\n$ pip install sigr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/sigr)\n[pages](https://dsm-72.github.io/sigr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/sigr) and\n[pypi](https://pypi.org/project/sigr/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "sigr",
"version": "0.0.12",
"project_urls": {
"Homepage": "https://github.com/dsm-72/sigr"
},
"split_keywords": [
"sigr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb70f484286fb93acbe0b8f999782f5593777c0081ed922f017707dc6f434016",
"md5": "d11ab9000b08136599f783f014191565",
"sha256": "e48e1564ca7e8424ba6e7ca5c2d27317cb889a29c47b2136c2234c2f0c2f41fd"
},
"downloads": -1,
"filename": "sigr-0.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d11ab9000b08136599f783f014191565",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 33660,
"upload_time": "2024-04-14T11:39:15",
"upload_time_iso_8601": "2024-04-14T11:39:15.786608Z",
"url": "https://files.pythonhosted.org/packages/fb/70/f484286fb93acbe0b8f999782f5593777c0081ed922f017707dc6f434016/sigr-0.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da1f75a908bb753593daf0e3db9196063f4d37f825ee0a5bea9f461b8a776325",
"md5": "3511a52f28d22fb878dbed80721c9709",
"sha256": "2dfc8dab69e7368ff14a30192533b7749fd3500b6c00b2d87e029bae18254261"
},
"downloads": -1,
"filename": "sigr-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "3511a52f28d22fb878dbed80721c9709",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 30765,
"upload_time": "2024-04-14T11:39:18",
"upload_time_iso_8601": "2024-04-14T11:39:18.294903Z",
"url": "https://files.pythonhosted.org/packages/da/1f/75a908bb753593daf0e3db9196063f4d37f825ee0a5bea9f461b8a776325/sigr-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 11:39:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "sigr",
"github_not_found": true,
"lcname": "sigr"
}
JSON
