Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • oop
  • explore-multiprocessing
  • refactor_AdiProcess
4 results
Compare History
Kefei Mo's avatar
fixed typos
Kefei Mo authored
50293bea
Name Last commit Last update
examples
src/adi_notebook
.gitignore
README.md
environment.yml
environment_pinned.yml
setup.py
README.md

adi-notebook

TODO: discuss the naming

About adi-notebook

Introducing adi_runner: A Comprehensive Python Package for Seamless Integration with PCM and ADI Systems

adi_runner is a versatile Python package designed to offer an intuitive API that simplifies interactions with PCM (Processing Configuration Manager) and ADI (ARM Data Integrator) technologies. This powerful tool empowers users to navigate ARM (Advanced RISC Machine) data, implement the VAPs (Value-added products) algorithm, and develop comprehensive VAPs workflows with ease.

Whether you're operating directly from the command line, embedding adi_runner within scripts, or leveraging it in an interactive development environment like Jupyter Notebook, this package is engineered to enhance your productivity and streamline your projects. adi_runner is especially beneficial for scientists and developers alike:

For Scientists: Integrate the results from PCM configurations and ADI algorithms seamlessly into your familiar research environments. adi_runner makes it easier to incorporate advanced computational techniques into your experimental analysis, fostering innovation and discovery.

For Developers: Transition scientific code into production-ready VAPs ADI pipelines effortlessly. adi_runner bridges the gap between research and real-world application, allowing for the smooth transfer of valuable insights into operational systems.

With adi_runner, both scientists and developers can unlock the full potential of their data and algorithms, paving the way for groundbreaking advancements in their respective fields. Welcome to a world of enhanced efficiency, precision, and versatility in PCM and ADI interactions.

Install

Support Python >= 3.8, using pip

$ pip install adi-notebook==0.0.2a4

NOTE: The package is still in active development, please include the version number "0.0.2a4" for reproducibility.

Explore the pacakge

New to adi-notebook? We recommend you start with the notebook Introducing_adi_notebook.ipynb. In order to run the notebook and explore the features we recommend you explore in a conda environment. Follow the steps to create a reproducible conda environment.

NOTE: If you have mamba installed, replace the "conda" command with "mamba" to increase the speed.

  1. Clone this repo

    git clone https://code.arm.gov/kefeimo/adi-notebook.git

  2. (Navigate to the repo path) Create a conda environment from file, with

    conda env create -f environment.yml

    or mamba env create -f environment.yml

  3. (After the enviornment is properly installed, which might take a while) activate the environment with conda activate adi_notebook

  4. Start the Jupyter Notebook server with jupyter notebook