Skip to main content

Tools for parsing and storing workflow nodes with support for pyiron and Python functions

Project description

License PyPI - backend PyPI - toolkit

backend frontend toolkit web-ide e2e

Sim Atlas

Search and discovery platform for simulation nodes — Python functions, workflow definitions, and pyiron nodes used in scientific computing.

Repository layout

sim_atlas/
├── backend/    FastAPI server (sim-atlas-backend)
├── frontend/   Search & discovery SPA, served at /
├── web_ide/    Visual workflow composer SPA, served at /ide
├── toolkit/    Client-side parser & upload library (sim-atlas-toolkit)
└── docs/       Architecture docs and ADRs

How it works

  1. Researchers run the toolkit on their machine to parse their Python packages and push node metadata to the server.
  2. The backend stores metadata, generates AI embeddings and AI-refined docstrings on demand, and exposes a REST API and MCP tool.
  3. The frontend and web_ide are React SPAs built into the backend's static directory and served by it.

Quickstart

1. Clone the repository and install it into a venv

cd <sim-atlas-env>
uv venv --python=3.12
uv pip install sim-atlas

2. Configure and start the backend

cd <sim-atlas-env>
uv run sim-atlas

On the first start the server will create a configuration file in the current working directory if it does not find one.

The API and both SPAs are now available at http://localhost:8000.

3. Generate an API token

Write access (uploading nodes) requires a JWT token:

cd <sim-atlas-env>
uv run sim-atlas-access-token "Your Name" "you@example.com"
export SIM_ATLAS_API_URL=http://localhost:8000/api/v1
export SIM_ATLAS_API_TOKEN=<token>

4. Upload nodes from a Python package

Load the environment with the modules you want to upload. Install the sim-atlas-toolkit into this environment. And upload the module. For example:

uv pip install sim-atlas-toolkit
uv run sim-atlas-upload --recursive filesystem mypackage.mymodule

5. Explore your newely created nodes

Head over to the webinterface and explore the nodes you uploaded:
http://localhost:8000

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sim_atlas_toolkit-0.0.4.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sim_atlas_toolkit-0.0.4-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file sim_atlas_toolkit-0.0.4.tar.gz.

File metadata

  • Download URL: sim_atlas_toolkit-0.0.4.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for sim_atlas_toolkit-0.0.4.tar.gz
Algorithm Hash digest
SHA256 3713c9237df89808f25e5a23cb36ac211893bb8de6894bcf3504ff9dd6448188
MD5 bacaefa26108c59d5094995514788f73
BLAKE2b-256 0a50f9b27b93c8fabae06aaa560837576a3f8f0fe1ebeb03e80b4bcac95a0216

See more details on using hashes here.

File details

Details for the file sim_atlas_toolkit-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: sim_atlas_toolkit-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for sim_atlas_toolkit-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 baf297e648068ee9d5eb7c160bec2745d4808277971c3cd27f81df3e9d5cd72c
MD5 22380914a29a3697135227a54d4f482c
BLAKE2b-256 9a0f4ba4091abd73963a29c505ba0bca2289a8677bdcd8f9dcb6c83eb0046b6d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page