https://github.com/uncscode/particula-beta
Particula-beta development for particula and sister packages.
https://github.com/uncscode/particula-beta
aerosol-chambers aerosol-chemistry aerosol-modelling aerosol-science aerosols microphysics
Last synced: 8 days ago
JSON representation
Particula-beta development for particula and sister packages.
- Host: GitHub
- URL: https://github.com/uncscode/particula-beta
- Owner: uncscode
- License: mit
- Created: 2024-10-06T23:41:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-02T16:45:14.000Z (5 months ago)
- Last Synced: 2025-09-05T10:48:40.217Z (5 months ago)
- Topics: aerosol-chambers, aerosol-chemistry, aerosol-modelling, aerosol-science, aerosols, microphysics
- Language: Python
- Homepage: https://uncscode.github.io/particula-beta/
- Size: 27.7 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license
- Citation: citation
- Codeowners: .github/codeowners
Awesome Lists containing this project
README
# 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:
```bash
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):
```bash
pip install git+https://github.com/uncscode/particula-beta.git@dev
```
- **Install a specific release version** (e.g., `v0.1.0`):
```bash
pip install git+https://github.com/uncscode/particula-beta.git@v0.1.0
```
- **Install from a specific commit** (replace `commit_hash` with an actual commit hash):
```bash
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:
```bash
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:
```bash
pip install --upgrade git+https://github.com/uncscode/particula-beta.git
```
or
```bash
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:
```bash
pip install -U git+https://github.com/uncscode/particula-beta.git@dev
```
- Upgrade to a specific release version:
```bash
pip install -U git+https://github.com/uncscode/particula-beta.git@v1.0.0
```
- Upgrade to a specific commit:
```bash
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:
```bash
pip install --force-reinstall git+https://github.com/uncscode/particula-beta.git
```
---