# adic
<!-- 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 adic --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install adic
```
### nbdev
``` sh
# activate conda environment
$ conda activate adic
# make sure the adic package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the adic 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/adic):
``` sh
$ pip install git+https://github.com/dsm-72/adic.git
```
or from [conda](https://anaconda.org/dsm-72/adic)
``` sh
$ conda install -c dsm-72 adic
```
or from [pypi](https://pypi.org/project/adic/)
``` sh
$ pip install adic
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/adic)
[pages](https://dsm-72.github.io/adic/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/adic) and
[pypi](https://pypi.org/project/adic/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/adic",
"name": "adic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/bf/db/422da4c879ef73c40c230ae797ece859a644de19433dfac272a75e920793/adic-0.0.1.tar.gz",
"platform": null,
"description": "# adic\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 adic --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install adic\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate adic\n\n# make sure the adic 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 adic 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/adic):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/adic.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/adic)\n\n``` sh\n$ conda install -c dsm-72 adic\n```\n\nor from [pypi](https://pypi.org/project/adic/)\n\n``` sh\n$ pip install adic\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/adic)\n[pages](https://dsm-72.github.io/adic/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/adic) and\n[pypi](https://pypi.org/project/adic/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "chaos package of utilities; a nod to adiclith",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/dsm-72/adic"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "60420765f059c7c2829a1adbe516e7a5a6a7c5f768a41e8ce978360e7effccf3",
"md5": "a15c67b469e303b1e31dd802cee7ccef",
"sha256": "096d995f5d736700df70bb19c8b82b95ca1d1a9dca00d9b934727a3d1bb264f8"
},
"downloads": -1,
"filename": "adic-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a15c67b469e303b1e31dd802cee7ccef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7542,
"upload_time": "2023-11-11T21:18:48",
"upload_time_iso_8601": "2023-11-11T21:18:48.952746Z",
"url": "https://files.pythonhosted.org/packages/60/42/0765f059c7c2829a1adbe516e7a5a6a7c5f768a41e8ce978360e7effccf3/adic-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfdb422da4c879ef73c40c230ae797ece859a644de19433dfac272a75e920793",
"md5": "9f418ddb0ab8dc501656f1410f10c09b",
"sha256": "2cd763c4e98c0737c8a845ed48b0fa1e88d0dbd697022b9c3d8119ce2d9833eb"
},
"downloads": -1,
"filename": "adic-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9f418ddb0ab8dc501656f1410f10c09b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8054,
"upload_time": "2023-11-11T21:18:50",
"upload_time_iso_8601": "2023-11-11T21:18:50.539871Z",
"url": "https://files.pythonhosted.org/packages/bf/db/422da4c879ef73c40c230ae797ece859a644de19433dfac272a75e920793/adic-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-11 21:18:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "adic",
"github_not_found": true,
"lcname": "adic"
}
JSON
