Local NeuronSphere Control CLI
Project description
hmd-cli-neuronsphere
A CLI tool for controlling the Local NeuronSphere experience.
Additional Requirements
- Docker Compose
- Docker
Configuration
Required Environment Variables:
HMD_HOME
: folder to store data and configuration for Local NeuronSphereHMD_REPO_HOME
: folder contianing NeuronSphere compliant projects, it is mounted into some services
Basic Commands
hmd neuronsphere up
: starts all enabled services in the Local NeuronSpherehmd neuronsphere down
: stops all enabled services in the Local NeuronSpherehmd neuronsphere run
: run within a NeuronSphere Microservice project to run it locally for testinghmd 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
- 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/
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 servicesHMD_LOCAL_NEURONSPHERE_ENABLE_AIRFLOW
: disables AirflowHMD_LOCAL_NEURONSPHERE_ENABLE_TRANSFORM
: disables Transform ServiceHMD_LOCAL_NEURONSPHERE_ENABLE_DYNAMODB
: disables DynamoDbHMD_LOCAL_NEURONSPHERE_ENABLE_APACHE_SUPERSET
: disables Explorer portal
Disabled services are not started and removed the next time you run hmd neuronsphere up
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for hmd_cli_neuronsphere-0.1.101-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87b1f8f22ee07139e5ee53e2528be79bd0353d5122ac7ee4e9bd7ca8f03cb510 |
|
MD5 | ec4b97ee62c804d8161c540a3e911f3c |
|
BLAKE2b-256 | 3f58bcf6d3e79211db8b24c27aeef3b350cd4682cd3b872ffbaf304060d73ee1 |