8000 GitHub - OpenChemistry/oremda: Open Reproducible Electron Microscopy Data Analysis · GitHub
[go: up one dir, main page]

Skip to content
OpenChemistryPublic

About

Open Reproducible Electron Microscopy Data Analysis

Topics

Resources

Stars

6 stars

Watchers

2 watching

Forks

Repository files navigation

Open Reproducible Electron Microscopy Data Analysis (OREMDA)

The OREMDA project is developing an open source platform for the analysis and visualization of electron microcopy data sets. We are leveraging container technologies to encapsulate processing into scalable, reproducible pipelines.

The OREMDA project is funded by DOE Office of Science contract DE-SC0021601.

Packages

The platform is broken up into several packages held in this monorepo.

  • oremda-core - the share library used by all packages.
  • oremda-cli - the command line interface used interact with the platform.
  • oremda-engine - the engine used to execution analysis pipelines.
  • oremda-server - the FastAPI application exposing the platforms RESTful API.
  • oremda-api - the API that operators are written to.
  • oremda - a meta package that can be used to install the entire platform.

Installation

The simplest way to install on the desktop is to use the meta package. A desktop installation requires Docker as a prerequisite.

pip install oremda

Getting started

Fetch the OREMDA operator images by issuing the following command:

oremda pull

Bring up the server components by issuing the following command:

oremda start

Then point your browser to: http://localhost:8000

Development

To setup up a development environment the following script can be used to cross link all the dependencies between the packages so local changes are used. Once development is finished there is a corresponding unlink script that can be used to unlink the local directories.

Contributing

Our project uses GitHub for code review, please fork the project and make a pull request if you would like us to consider your patch for inclusion.

Kitware, Inc.

About

Open Reproducible Electron Microscopy Data Analysis

Topics

Resources

Stars

6 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages

0