A CLI tool for controlling the Local NeuronSphere.
Additional Requirements
Docker Compose
Docker
Configuration
Required Environment Variables:
HMD_HOME: folder to store data and configuration for Local NeuronSphere
HMD_REPO_HOME: folder containing NeuronSphere compliant projects, it is mounted into some services
Commands
hmd neuronsphere up: starts all enabled services in the Local NeuronSphere
hmd neuronsphere down: stops all enabled services in the Local NeuronSphere
hmd neuronsphere run: run within a NeuronSphere Microservice project to run it locally for testing
hmd neuronsphere update-images: pull down updated images to run
Included Services
All services are enabled by default.
Gateway Proxy Server: used to forward calls to running NeuronSphere Microservices
Postgres Database: relational storage backend for running NeuronSphere Microservices
DynamoDB: NoSQL storage backend for running NeuronSphere Microservices
Jupyter Lab Server: used to run Jupyter Notebooks, mounts HMD_REPO_HOME for project access, located at http://localhost:8888/
NeuronSphere Transform Service: a local instance of the NeuronSphere Transform service to test NeuronSphere Transforms locally
Trino: a Trino database instance to use with local Transforms http://localhost:8081
Airflow: an Airflow instance used by the Transform Service, located at http://localhost:175/
Explorer Portal: an instance of the NeuronSphere Explorer portal for local dashboard development, located at http://localhost:8088/
Minio Object Storage: http://localhost:9001
SQS Queues: http://localhost:9235
The following environment variables disable certain services by setting them to ‘false’. For example, hmd configure set-env HMD_LOCAL_NEURONSPHERE_ENABLE_TRINO false will disable Trino.
HMD_LOCAL_NEURONSPHERE_ENABLE_TRINO: disables Trino services
HMD_LOCAL_NEURONSPHERE_ENABLE_AIRFLOW: disables Airflow
HMD_LOCAL_NEURONSPHERE_ENABLE_TRANSFORM: disables Transform Service
HMD_LOCAL_NEURONSPHERE_ENABLE_DYNAMODB: disables DynamoDb
HMD_LOCAL_NEURONSPHERE_ENABLE_APACHE_SUPERSET: disables Explorer portal
Disabled services are not started and removed the next time you run hmd neuronsphere up.
1 maintainer
Metadata
1 maintainer
Release files for hmd-cli-neuronsphere 0.4.180
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hmd_cli_neuronsphere-0.4.180-py3-none-any.whl | Python 3 | none | any | Details |
Release files / hmd_cli_neuronsphere-0.4.180-py3-none-any.whl
| Download URL | hmd_cli_neuronsphere-0.4.180-py3-none-any.whl |
|---|---|
| Size | 217.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8b40d2c663b42952ad0736d0b2a8bd33d9ec7430c78f31dbb4cd51640e9ab33d
|
|
BLAKE2b-256 checksum How to use checksums |
70b8dbb7897649951b40d6a9942ab73a4ea387bf56da82722aa8219cd839f803
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.14
|
Security for hmd-cli-neuronsphere 0.4.180
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
