A python library that provides data acquisition and processing assets shared between Sun (NeuroAI) lab libraries.
Primarily, this library is designed to make the two main Sun lab libraries used for data acquisition (sl-experiment) and processing (sl-forgery) independent of each other.
The library broadly stores two types of assets. First, it stores dataclasses used to save the data acquired in the lab and configure data acquisition and processing runtimes. Second, it provides the low-level tools and methods used to manage the data at all stages of Sun lab data workflow: acquisition, processing, and analysis.
All software library dependencies are installed automatically as part of the library installation.
Note, installation from source is highly discouraged for everyone who is not an active project developer.
- Download this repository to your local machine using any method, such as Git-cloning. Use one of the stable releases from GitHub.
- Unpack the downloaded zip and note the path to the binary wheel (
.whl) file contained in the archive. - Run
python -m pip install WHEEL_PATH, replacing 'WHEEL_PATH' with the path to the wheel file, to install the wheel into the active python environment.
Use the following command to install the library using pip: pip install sl-shared-assets.
Most library components are intended to be used via other Sun lab libraries. For details on using shared assets for data acquisition and preprocessing, see the sl-experiment library. For details on using shared assets for data processing and dataset formation, see the sl-forgery library.
Warning! End users should not use any component of this library directly or install this library into any Python environment. All assets from this library are intended to be used exclusively by developers working on other Sun lab libraries.
Developers working on integrating sl-shared-assets into other libraries should see the API documentation for the detailed description of the methods and classes exposed by components of this library.
Note! The API documentation includes important information about Command-Line Interfaces (CLIs) exposed by this library as part of installation into a Python environment.
This project uses semantic versioning. For the versions available, see the tags on this repository.
- Ivan Kondratyev (Inkaros)
- Kushaan Gupta (kushaangupta)
- Natalie Yeung
This project is licensed under the GPL3 License: see the LICENSE file for details.
- All Sun lab members for providing the inspiration and comments during the development of this library.
- The creators of all other projects used in the development automation pipelines and source code of this project see pyproject.toml.