Skip to main content

Tools for working with the RSpace ELN

Project description

inm-rspace

Python tools for interaction with the Rspace Electronic Lab Notebook. Developed at INM - Leibniz Institute for New Materials in Saarbrücken, Germany.

inm-rspace adds functionality to the rspace-client API to make it easier to include personal scientific data workflows.

Installation and Setup

You can install the API package PyPI, which should automatically take care of installing dependencies (especially rspace-client). Simply type:

pip install inm-rspace

However, to use the API, you need to first create an API key as explained here. Furthermore, inm-rspace assumes you have saved this API key as RSPACE_API_KEY along with your RSpace URL as RSPACE_URL (e.g. https://leibniz-inm.researchspace.com) and as environment variables in your terminal.

Examples

To learn how to generally use the rspace-client API, please refer to their examples.

As for how to use the inm-rspace extension for workflows, check the examples folder of this repository.

Documentation

The full API documentation is still in progress, but the current state is already available here.

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

inm_rspace-0.3.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

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

inm_rspace-0.3-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file inm_rspace-0.3.tar.gz.

File metadata

  • Download URL: inm_rspace-0.3.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.10 Darwin/24.5.0

File hashes

Hashes for inm_rspace-0.3.tar.gz
Algorithm Hash digest
SHA256 4f3d41d71bc007f3bee3b1abb17b9b973db978a027f383c7ed31c49f3ac19608
MD5 d7e3d53a4af6b0addc6bf1cb2d7fed4b
BLAKE2b-256 ba136274dad248ecbe53842ec90ad6c80c5e687f08d24e5952ea92bddfce5dff

See more details on using hashes here.

File details

Details for the file inm_rspace-0.3-py3-none-any.whl.

File metadata

  • Download URL: inm_rspace-0.3-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.10 Darwin/24.5.0

File hashes

Hashes for inm_rspace-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 596f0c9597ab461a36467bf8d162fc347f6190fddde985e79a385f5cbbbd81d7
MD5 3a25f86f8fc1832c24832ee75b06b5e5
BLAKE2b-256 a9261dc0381df3d797c9f44ad65611031150122c2eff77ce5af5afb80e276d86

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