# calr
<!-- 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 calr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install calr
```
### nbdev
``` sh
# activate conda environment
$ conda activate calr
# make sure the calr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the calr 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/calr):
``` sh
$ pip install git+https://github.com/dsm-72/calr.git
```
or from [conda](https://anaconda.org/dsm-72/calr)
``` sh
$ conda install -c dsm-72 calr
```
or from [pypi](https://pypi.org/project/calr/)
``` sh
$ pip install calr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/calr)
[pages](https://dsm-72.github.io/calr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/calr) and
[pypi](https://pypi.org/project/calr/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/calr",
"name": "calr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "calr",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/95/c3/c2dfb6a62fe1e50c06afcdaaa0e902b8b4338a1838bc4818ef25bcf85501/calr-0.0.11.tar.gz",
"platform": null,
"description": "# calr\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 calr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install calr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate calr\n\n# make sure the calr 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 calr 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/calr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/calr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/calr)\n\n``` sh\n$ conda install -c dsm-72 calr\n```\n\nor from [pypi](https://pypi.org/project/calr/)\n\n``` sh\n$ pip install calr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/calr)\n[pages](https://dsm-72.github.io/calr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/calr) and\n[pypi](https://pypi.org/project/calr/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "calr",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://github.com/dsm-72/calr"
},
"split_keywords": [
"calr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94de63f00df126534769073ecc3d32e185be33bb11b034d91b14ee8452d80e5d",
"md5": "4edf03b980386377b8e4514bf10150d1",
"sha256": "1e5a7da20feb8acfec6070a791ae7081ee883c1b7aad8174d09b2f6bc157f552"
},
"downloads": -1,
"filename": "calr-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4edf03b980386377b8e4514bf10150d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7907,
"upload_time": "2024-02-26T13:47:27",
"upload_time_iso_8601": "2024-02-26T13:47:27.986739Z",
"url": "https://files.pythonhosted.org/packages/94/de/63f00df126534769073ecc3d32e185be33bb11b034d91b14ee8452d80e5d/calr-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95c3c2dfb6a62fe1e50c06afcdaaa0e902b8b4338a1838bc4818ef25bcf85501",
"md5": "a783b1ac8130fac52cd19c065ad49279",
"sha256": "1a54ff35e932b61d707621599aa86e2254930e8838cd777a16ee18e705bd7685"
},
"downloads": -1,
"filename": "calr-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "a783b1ac8130fac52cd19c065ad49279",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8424,
"upload_time": "2024-02-26T13:47:28",
"upload_time_iso_8601": "2024-02-26T13:47:28.973708Z",
"url": "https://files.pythonhosted.org/packages/95/c3/c2dfb6a62fe1e50c06afcdaaa0e902b8b4338a1838bc4818ef25bcf85501/calr-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 13:47:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "calr",
"github_not_found": true,
"lcname": "calr"
}
JSON
