# cpus
<!-- 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 cpus --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install cpus
```
### nbdev
``` sh
# activate conda environment
$ conda activate cpus
# make sure the cpus package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the cpus 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/cpus):
``` sh
$ pip install git+https://github.com/dsm-72/cpus.git
```
or from [conda](https://anaconda.org/dsm-72/cpus)
``` sh
$ conda install -c dsm-72 cpus
```
or from [pypi](https://pypi.org/project/cpus/)
``` sh
$ pip install cpus
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/cpus)
[pages](https://dsm-72.github.io/cpus/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/cpus) and
[pypi](https://pypi.org/project/cpus/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/cpus",
"name": "cpus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "cpus is question bool type guard typeguard check cpus",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/ee/73/d69262884604fa29bb18b7e9b9cc36631a4cb7e1c42bff75436915a462e2/cpus-0.0.3.tar.gz",
"platform": null,
"description": "# cpus\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 cpus --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install cpus\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate cpus\n\n# make sure the cpus 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 cpus 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/cpus):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/cpus.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/cpus)\n\n``` sh\n$ conda install -c dsm-72 cpus\n```\n\nor from [pypi](https://pypi.org/project/cpus/)\n\n``` sh\n$ pip install cpus\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/cpus)\n[pages](https://dsm-72.github.io/cpus/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/cpus) and\n[pypi](https://pypi.org/project/cpus/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "cpus",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/dsm-72/cpus"
},
"split_keywords": [
"cpus",
"is",
"question",
"bool",
"type",
"guard",
"typeguard",
"check",
"cpus"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d5db2401b51f97655c8c1cfb82f48957dfb304e6401e08dc34addbb207f873af",
"md5": "2671a55f088d87c167a8049249696684",
"sha256": "322adf44fec156e5466b34246f9c981a366a6799ac959b4a0719d1516640b5d1"
},
"downloads": -1,
"filename": "cpus-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2671a55f088d87c167a8049249696684",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9120,
"upload_time": "2024-04-04T12:31:12",
"upload_time_iso_8601": "2024-04-04T12:31:12.190364Z",
"url": "https://files.pythonhosted.org/packages/d5/db/2401b51f97655c8c1cfb82f48957dfb304e6401e08dc34addbb207f873af/cpus-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee73d69262884604fa29bb18b7e9b9cc36631a4cb7e1c42bff75436915a462e2",
"md5": "db8030dbafb38dd8ada4cd48ff3bf3e9",
"sha256": "125cde0d33803dc4cb9bf6157d66b41e37787171bf68fe399b3322d8b8169b01"
},
"downloads": -1,
"filename": "cpus-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "db8030dbafb38dd8ada4cd48ff3bf3e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9590,
"upload_time": "2024-04-04T12:31:13",
"upload_time_iso_8601": "2024-04-04T12:31:13.818044Z",
"url": "https://files.pythonhosted.org/packages/ee/73/d69262884604fa29bb18b7e9b9cc36631a4cb7e1c42bff75436915a462e2/cpus-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 12:31:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "cpus",
"github_not_found": true,
"lcname": "cpus"
}
JSON
