Getting Started#

 

This section provides instructions for setting up your development environment and requesting for data access, outlining the prerequisites to get started with BONSAI-IO.

Installation Guide#

Environment Settings#

  • Ensure you have Python3.10 or Python3.11 installed on your system. You can verify this by running python --version.

  • Ensure Git is installed on your system. You can verify this by running git --version.

  • Get an API token from our website. To register a token, you first need to sign up for a user account. Then, enter your credentials when prompted.

  • Setup environmental variables for BONSAI_HOME as /path/to/bonsai_data/.

    • in Windows

    • in MacOS

    • in Linux

    • You can also do it programmatically as a quick test:

      import os

os.environ["BONSAI_HOME"] = "/path/to/bonsai_data/"

Note

/path/to/bonsai_data/ should be the parent directory of ./_bonsai/. If you have all the data in /home/MadsMikkelsen/Document/_bonsai/, then BONSAI_HOME should be set as /home/MadsMikkelsen/Document.

Data Access#

To inquiry about the access to data in order to use the application, you can

Install from PyPi#

Coming soon

Install from Source#

  1. Clone the repository use git clone git@gitlab.com:bonsamurais/bonsai/build/hybrid_sut.git.

  2. Navigate to the repository cd /path/to/hybrid_sut.

  3. For use without modification, run pip install . to install the package.

  4. To install a specific version, run git checkout tags/<version_number>, and then run pip install ..

  5. Alternatively, for editable installation, run pip install -e ..

Upgrade from Source#

  1. Navigate to your local repository: cd /path/to/hybrid_sut.

  2. Get the latest updates from the source repository: git fetch --all.

  3. Upgrade to:

    • The latest version:

      git pull origin main
pip install .

    • A specific version:

      git checkout tag/<version_number>
pip install .

Add as a Dependency#

If you want to add bonsai-io as a dependency to your package, you can do it by adding this line to setup.cfg or pyproject.toml:

bonsai-io @ git+ssh://git@gitlab.com/bonsamurais/bonsai/build/hybrid_sut.git