| Name | epx JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Client for running simulations with Epistemix Platform Cloud. |
| upload_time | 2024-12-06 16:59:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright 2024 Epistemix, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
abm
epistemix
fred
client
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Epistemix Platform Client
For users of the epx client please visit our [documentation](https://docs.epsitemix.com/epx-client-docs/)
# Epistemix Platform Client Developers Guide
Client for running simulations with Epistemix Platform Cloud.
## Branching Strategy
This repo follows the environment strategy described
[here](https://github.com/Epistemix-Inc/poc-gitlabflow-release).
## Development
### Initial setup
To bootstrap the development environment using a Python virtual environment,
run
```shell
. scripts/setup
```
This will create and activate the development Python environment. This
environment can be reactivated subsequently in a different shell session with
```shell
source .venv/bin/activate
```
### Pre-commit
Before committing, developers are asked to run the following scripts and resolve
any identified issues:
```shell
scripts/test
scripts/format
scripts/lint
```
### Test data generation
Test data is generated in the `scripts/test/tests` directory. Note that the
test data is checked into this repo and should only need to be regenerated
if the generation script needs to be changed. See `resources/tests/README.md`
for more details.
### Testing integration with SRS
The best known way to test `epx_client`'s interaction with SRS is to package
it up, install it in the Platform, and perform manual testing in-situ. This
can be done by following these steps:
#### 1. Build the Program
Checkout the feature branch that you want to build. Make sure you are in a virtual
environment (see [initial setup](#initial-setup)). Build the epx python package:
```shell
python -m build
```
This will create package artifacts in the `/dist` directory.
#### 2. Upload the Artifact to Platform
Within the Platform environment that you wish to test in, click the upload file
button from the file menu. Upload the built `.tar.gz` artifact from your local
`/dist` directory.
<img src="./img/upload-button.png" alt="upload button" width="250"/>
#### 3. Install `epx_client` on the Platform
Use `pip` to install the artifact on the Platform. E.g. if your build artifact
is called `~/packages/epx-0.0.0+unknown.tar.gz`, run
```shell
python -m pip install --user --force-reinstall ~/packages/epx-0.0.0+unknown.tar.gz
```
This can be done either using the Platform terminal, or from within a notebook.
`--force-reinstall` forces pip to install the most recently uploaded package artifact.
#### 4. Perform manual tests as required
#### 5. Revert back to default version of epx
To reset your Platform IDE to use the originally installed version of `epx_client`, uninstall
`epx_client`. Since the testing version was installed for your user account only (`--user`),
the globally installed version will show as the installed version.
```shell
python -m pip uninstall epx -y
```
## Documentation
Documentation for the package uses the [Sphinx](https://www.sphinx-doc.org)
framework in the `docs` directory. To build and locally host the docs at port
`8000` run
```shell
scripts/docs
```
## Making a Release
To make a release, follow the process described [here.](https://github.com/Epistemix-com/poc-gitlabflow-release?tab=readme-ov-file#releasing-to-production)
Raw data
{
"_id": null,
"home_page": null,
"name": "epx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ABM, Epistemix, FRED, client",
"author": null,
"author_email": "Andrew Lane <andrew.lane@epistemix.com>",
"download_url": "https://files.pythonhosted.org/packages/e3/c8/386074f7d809a12cc38f5d9acb2781256068259d411995c69c2f96df694f/epx-1.0.0.tar.gz",
"platform": null,
"description": "# Epistemix Platform Client\nFor users of the epx client please visit our [documentation](https://docs.epsitemix.com/epx-client-docs/)\n\n# Epistemix Platform Client Developers Guide\n\nClient for running simulations with Epistemix Platform Cloud.\n\n## Branching Strategy\n\nThis repo follows the environment strategy described\n[here](https://github.com/Epistemix-Inc/poc-gitlabflow-release).\n\n## Development\n\n### Initial setup\n\nTo bootstrap the development environment using a Python virtual environment,\nrun\n\n```shell\n. scripts/setup\n```\n\nThis will create and activate the development Python environment. This\nenvironment can be reactivated subsequently in a different shell session with\n\n```shell\nsource .venv/bin/activate\n```\n\n### Pre-commit\n\nBefore committing, developers are asked to run the following scripts and resolve\nany identified issues:\n\n```shell\nscripts/test\nscripts/format\nscripts/lint\n```\n\n### Test data generation\n\nTest data is generated in the `scripts/test/tests` directory. Note that the\ntest data is checked into this repo and should only need to be regenerated\nif the generation script needs to be changed. See `resources/tests/README.md`\nfor more details.\n\n### Testing integration with SRS\n\nThe best known way to test `epx_client`'s interaction with SRS is to package\nit up, install it in the Platform, and perform manual testing in-situ. This\ncan be done by following these steps:\n\n#### 1. Build the Program\n\n\nCheckout the feature branch that you want to build. Make sure you are in a virtual\nenvironment (see [initial setup](#initial-setup)). Build the epx python package:\n\n```shell\npython -m build\n```\n\nThis will create package artifacts in the `/dist` directory.\n\n#### 2. Upload the Artifact to Platform\n\nWithin the Platform environment that you wish to test in, click the upload file\nbutton from the file menu. Upload the built `.tar.gz` artifact from your local\n`/dist` directory.\n\n<img src=\"./img/upload-button.png\" alt=\"upload button\" width=\"250\"/>\n\n#### 3. Install `epx_client` on the Platform\n\nUse `pip` to install the artifact on the Platform. E.g. if your build artifact\nis called `~/packages/epx-0.0.0+unknown.tar.gz`, run\n\n```shell\npython -m pip install --user --force-reinstall ~/packages/epx-0.0.0+unknown.tar.gz\n```\nThis can be done either using the Platform terminal, or from within a notebook.\n\n`--force-reinstall` forces pip to install the most recently uploaded package artifact.\n\n#### 4. Perform manual tests as required\n\n#### 5. Revert back to default version of epx\n\nTo reset your Platform IDE to use the originally installed version of `epx_client`, uninstall\n`epx_client`. Since the testing version was installed for your user account only (`--user`),\nthe globally installed version will show as the installed version.\n\n```shell\npython -m pip uninstall epx -y\n```\n\n## Documentation\n\nDocumentation for the package uses the [Sphinx](https://www.sphinx-doc.org)\nframework in the `docs` directory. To build and locally host the docs at port\n`8000` run\n\n```shell\nscripts/docs\n```\n\n## Making a Release\n\nTo make a release, follow the process described [here.](https://github.com/Epistemix-com/poc-gitlabflow-release?tab=readme-ov-file#releasing-to-production)",
"bugtrack_url": null,
"license": "Copyright 2024 Epistemix, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Client for running simulations with Epistemix Platform Cloud.",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"abm",
" epistemix",
" fred",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c64c4e917553cc7169894189e808bbfb3bfb42f43bf455aac88d34701b22284b",
"md5": "f12e06361b99f17b5dbd48eae100e612",
"sha256": "3b94c5e0ebce98a14ccd82aa7c2b3679ca9edf244a644b0e3048a128250e3464"
},
"downloads": -1,
"filename": "epx-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f12e06361b99f17b5dbd48eae100e612",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 49453,
"upload_time": "2024-12-06T16:59:28",
"upload_time_iso_8601": "2024-12-06T16:59:28.075725Z",
"url": "https://files.pythonhosted.org/packages/c6/4c/4e917553cc7169894189e808bbfb3bfb42f43bf455aac88d34701b22284b/epx-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e3c8386074f7d809a12cc38f5d9acb2781256068259d411995c69c2f96df694f",
"md5": "083c7e72be9b37917baf13e8b75b4f42",
"sha256": "fab5d703bcacde5771e5f4dc59cf7648b6b60170289c4d580d64e1b2c9489df3"
},
"downloads": -1,
"filename": "epx-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "083c7e72be9b37917baf13e8b75b4f42",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 79199,
"upload_time": "2024-12-06T16:59:30",
"upload_time_iso_8601": "2024-12-06T16:59:30.183081Z",
"url": "https://files.pythonhosted.org/packages/e3/c8/386074f7d809a12cc38f5d9acb2781256068259d411995c69c2f96df694f/epx-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 16:59:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "epx"
}
