Overview

Particula-Beta is the development platform for the Particula package.

---

Installation

You can install particula-beta directly from GitHub using pip. This allows you to get the latest version of the package, even if it is not yet published on PyPI.

Install the Latest Version

To install the latest version from the main branch, run:

pip install git+https://github.com/uncscode/particula-beta.git

Install a Specific Branch, Tag, or Commit

If you want to install a specific version of particula-beta, you can specify a branch, tag, or commit in the installation command.

• Install from a specific branch (e.g., dev branch):

  pip install git+https://github.com/uncscode/particula-beta.git@dev

• Install a specific release version (e.g., v0.1.0):

  pip install git+https://github.com/uncscode/[email protected]

• Install from a specific commit (replace commit_hash with an actual commit hash):

  pip install git+https://github.com/uncscode/particula-beta.git@commit_hash

Verifying Installation

After installation, you can verify that particula-beta is installed correctly by running:

python -c "import particula_beta; print(particula_beta.__version__)"

If the package was installed successfully, this command will print the installed version of particula-beta.

---

Upgrading particula-beta

To upgrade to the latest version of particula-beta, use:

pip install --upgrade git+https://github.com/uncscode/particula-beta.git

or

pip install -U git+https://github.com/uncscode/particula-beta.git

If you need a specific branch, tag, or commit:

• Upgrade to a specific branch:

  pip install -U git+https://github.com/uncscode/particula-beta.git@dev

• Upgrade to a specific release version:

  pip install -U git+https://github.com/uncscode/[email protected]

• Upgrade to a specific commit:

  pip install -U git+https://github.com/uncscode/particula-beta.git@commit_hash

If the upgrade does not apply correctly, you can force a reinstall:

pip install --force-reinstall git+https://github.com/uncscode/particula-beta.git

---