# quac
<!-- 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 quac --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install quac
```
### nbdev
``` sh
# activate conda environment
$ conda activate quac
# make sure the quac package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the quac 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/quac):
``` sh
$ pip install git+https://github.com/dsm-72/quac.git
```
or from [conda](https://anaconda.org/dsm-72/quac)
``` sh
$ conda install -c dsm-72 quac
```
or from [pypi](https://pypi.org/project/quac/)
``` sh
$ pip install quac
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/quac)
[pages](https://dsm-72.github.io/quac/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/quac) and
[pypi](https://pypi.org/project/quac/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/quac",
"name": "quac",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "quac",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/a5/11/4cd2b7ba9d9d20aaddbab8f2d8639c4e43b6d0e9dd1a6cd7135ca5a2a434/quac-0.0.45.tar.gz",
"platform": null,
"description": "# quac\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 quac --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install quac\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate quac\n\n# make sure the quac 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 quac 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/quac):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/quac.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/quac)\n\n``` sh\n$ conda install -c dsm-72 quac\n```\n\nor from [pypi](https://pypi.org/project/quac/)\n\n``` sh\n$ pip install quac\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/quac)\n[pages](https://dsm-72.github.io/quac/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/quac) and\n[pypi](https://pypi.org/project/quac/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "quac",
"version": "0.0.45",
"project_urls": {
"Homepage": "https://github.com/dsm-72/quac"
},
"split_keywords": [
"quac"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ef769039498922e65c1441a52785f532e2626f4dcd8f4a54f082c4182d4b638",
"md5": "9c0107e24f494e0d9e8829ec6bbda960",
"sha256": "44fde12c117053e1999283e3db62998c4d3e20161ce92d3b55cdc69b12ee26ac"
},
"downloads": -1,
"filename": "quac-0.0.45-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c0107e24f494e0d9e8829ec6bbda960",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 49116,
"upload_time": "2024-04-05T17:37:25",
"upload_time_iso_8601": "2024-04-05T17:37:25.491424Z",
"url": "https://files.pythonhosted.org/packages/4e/f7/69039498922e65c1441a52785f532e2626f4dcd8f4a54f082c4182d4b638/quac-0.0.45-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a5114cd2b7ba9d9d20aaddbab8f2d8639c4e43b6d0e9dd1a6cd7135ca5a2a434",
"md5": "cab4f06f3ced199bf1ffe78fed9615bb",
"sha256": "0d91ce179721ee463ebe9e36c25b0ab4a9432ebc6030035a81e083a2b921d823"
},
"downloads": -1,
"filename": "quac-0.0.45.tar.gz",
"has_sig": false,
"md5_digest": "cab4f06f3ced199bf1ffe78fed9615bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 45820,
"upload_time": "2024-04-05T17:37:26",
"upload_time_iso_8601": "2024-04-05T17:37:26.912184Z",
"url": "https://files.pythonhosted.org/packages/a5/11/4cd2b7ba9d9d20aaddbab8f2d8639c4e43b6d0e9dd1a6cd7135ca5a2a434/quac-0.0.45.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 17:37:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "quac",
"github_not_found": true,
"lcname": "quac"
}
JSON
