# xpos
<!-- 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 xpos --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install xpos
```
### nbdev
``` sh
# activate conda environment
$ conda activate xpos
# make sure the xpos package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the xpos 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/xpos):
``` sh
$ pip install git+https://github.com/dsm-72/xpos.git
```
or from [conda](https://anaconda.org/dsm-72/xpos)
``` sh
$ conda install -c dsm-72 xpos
```
or from [pypi](https://pypi.org/project/xpos/)
``` sh
$ pip install xpos
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/xpos)
[pages](https://dsm-72.github.io/xpos/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/xpos) and
[pypi](https://pypi.org/project/xpos/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/fpos",
"name": "fpos",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "fpos",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/69/71/282ace91caec60df058d47b3a5af84736ae9120e697016a95ba8c3e355ef/fpos-0.0.2.tar.gz",
"platform": null,
"description": "# xpos\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 xpos --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install xpos\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate xpos\n\n# make sure the xpos 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 xpos 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/xpos):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/xpos.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/xpos)\n\n``` sh\n$ conda install -c dsm-72 xpos\n```\n\nor from [pypi](https://pypi.org/project/xpos/)\n\n``` sh\n$ pip install xpos\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/xpos)\n[pages](https://dsm-72.github.io/xpos/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/xpos) and\n[pypi](https://pypi.org/project/xpos/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "fpos",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/dsm-72/fpos"
},
"split_keywords": [
"fpos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4b1b7b6ab906a28ffd65326aa69e3b46092d1390a4b26488c3ba2236eafd4e7",
"md5": "056d91ada169576c07f4ded21ad77c8a",
"sha256": "d8312ce56a7c7ea60fdd5d12ce98309c15aa7f8a0050bade16341b6978970f4c"
},
"downloads": -1,
"filename": "fpos-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "056d91ada169576c07f4ded21ad77c8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8789,
"upload_time": "2024-03-11T18:10:44",
"upload_time_iso_8601": "2024-03-11T18:10:44.365009Z",
"url": "https://files.pythonhosted.org/packages/e4/b1/b7b6ab906a28ffd65326aa69e3b46092d1390a4b26488c3ba2236eafd4e7/fpos-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6971282ace91caec60df058d47b3a5af84736ae9120e697016a95ba8c3e355ef",
"md5": "5113e6cf70e286d243f2e4073dbfd778",
"sha256": "462c7bdd1291885687409e1eebcf6f55f30019d2822c340f2f026ba7d465462e"
},
"downloads": -1,
"filename": "fpos-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "5113e6cf70e286d243f2e4073dbfd778",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9339,
"upload_time": "2024-03-11T18:10:45",
"upload_time_iso_8601": "2024-03-11T18:10:45.904080Z",
"url": "https://files.pythonhosted.org/packages/69/71/282ace91caec60df058d47b3a5af84736ae9120e697016a95ba8c3e355ef/fpos-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-11 18:10:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "fpos",
"github_not_found": true,
"lcname": "fpos"
}
JSON
