AcidWatch

Democratize and open up the discussion around CO2 impurities and provide a reliable resource for researchers, chemists, and industry professionals in the CCS domain.
https://github.com/equinor/acidwatch

Category: Emissions
Sub Category: Carbon Capture

Keywords

carbon-capture-and-storage ccs computational-chemistry hacktoberfest hacktoberfestivus impurities

Last synced: about 14 hours ago
JSON representation

Repository metadata

AcidWatch is a platform for modeling chemical reactions in CO2 streams, designed for researchers in CCS.

README.md

Build and deploy to Radix
Promote prod environment

AcidWatch

AcidWatch is a portal for tools that calculate and predict chemical reactions in
CO2 streams. It is essential for advancing and scaling carbon capture
and storage (CCS) technologies. The goal of AcidWatch is to democratize and open
up the discussion around CO2 impurities and provide a reliable
resource for researchers, chemists, and industry professionals in the CCS
domain.

Using

The production version of AcidWatch is found at https://acidwatch.radix.equinor.com/ . Some features require an Equinor account with appropriate accesses.

Developing

AcidWatch uses Python in the backend and Javascript in the frontend.

Running with Docker Compose

The quickest way to get the full stack running locally is via Docker
Compose
. From the repository root:

# Create the (optional) env files used by the containers
cp backend/.env.example backend/.env
cp frontend/.env.example frontend/.env

# Build and start both services
docker compose up --build

This starts:

Stop the stack with Ctrl-C, or run docker compose down if you started it
with -d. The Compose setup uses backend/Dockerfile.local
and frontend/Dockerfile.local, which run the
services in development mode with hot reload.

If you'd rather run the services directly on your host, follow the Backend and
Frontend sections below.

Backend

The backend is written using FastAPI and SQLAlchemy.

Using uv, install AcidWatch's backend using the following command:

uv sync

Then, run the backend in development mode using the following command:

uv run python -m acidwatch_api

To change the settings, first copy backend/.env.example to backend/.env and
then modify it to suit your needs.

To install and run a production build of the backend, refer to the backend
Dockerfile
.

Explore the auto-generated REST API at http://localhost:8000/docs

SQLite

By default, AcidWatch uses an in-memory SQLite database. It requires no
additional installation or setup, but will reset whenever the backend is
restarted.

To enable a persistent SQLite database, set ACIDWATCH_DATABASE in
backend/.env file. For example, adding the following will create a test.db
file in the directory from which acidwatch-api is ran:

ACIDWATCH_DATABASE=sqlite:///test.db

[!TIP]
Database migration aren't applied to SQLite. If mysterious database errors
occur, delete your database file and restart.

PostgreSQL

AcidWatch uses a PostgreSQL database in production.

First, ensure that the backend is installed with the pg (PostgreSQL) optional
dependency group. This installs the recommended SQLAlchemy driver:

uv sync --package acidwatch-api --extra pg

Then, set the ACIDWATCH_DATABASE as described in the SQLite section to the following:

# Over TCP/IP
ACIDWATCH_DATABASE=postgresql://[username]:[password]@[hostname]:[port]/[database]

# Over UNIX sockets
ACIDWATCH_DATABASE=postgresql:///[database]?host=[path]

# For example:
ACIDWATCH_DATABASE=postgresql://postgres:password@localhost:5432/acidwatch

AcidWatch uses SQLAlchemy's Alembic to handle migrations. Run uv run alembic upgrade head to migrate the database to the current schema.

Don't have a postgres running? Here's a simple docker setup, that will create the necessary
database to work with the example above:

docker run -e POSTGRES_PASSWORD=password -e POSTGRES_DB=acidwatch -p 5432:5432 postgres

For other databases, refer to SQLAlchemy documentation on how to create

Workers

Each worker is an independent uv project with its own lockfile and virtual
environment. From a worker directory, install and test only that worker:

cd workers/example
uv sync
uv run pytest

The worker projects use local path sources for the shared messaging, model, and
runtime packages. Their third-party dependencies are resolved independently, so
dependency conflicts in one worker do not affect the backend or other workers.
See the example worker for the contributor
workflow and standalone execution interface.

Frontend

The frontend uses Vite and React. Components are provided by the official
Equinor Design System React library.

# Copy the .env file
cp frontend/.env.example frontend/.env

# then install
npm -C frontend install

To run, ensure that the backend is running on port 8000 and then:

npm -C frontend run dev

The application is now available at http://localhost:5173

Considerations

Debugging in Visual Studio Code

If using VS Code it is recommended to run backend in a different instances of VS Code. This will avoid a lot of hazzle configuring and running correct python virtual environment etc.

Deployment

GitHub Actions Workflows are used for building, testing and deploying AcidWatch to Radix.

Tests are run on every push, and deployment to dev environment are done on merge to main branch.

Deployment to prod environment is for now done manually in Radix console.

GitHub Codespaces

If someone fancies using codespaces and wants to break out of the tedious local setup then following steps can be followed.

1. Setup frontend

Open a terminal and write following commands to run frontend.

cd frontend
npm run dev

2. Setup backend

Open another terminal and run the backend with uv:

uv sync
uv run python -m acidwatch_api

3. Toggle port visibility

Kudos! Now frontend is running on port 5173, and backend is on 8000. Toggle the port for backend only to be public so it's accessible by frontend.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 820
Total Committers: 14
Avg Commits per committer: 58.571
Development Distribution Score (DDS): 0.723

Commits in past year: 339
Committers in past year: 10
Avg Commits per committer in past year: 33.9
Development Distribution Score (DDS) in past year: 0.496

Name Email Commits
Lars Petter Hauge l****e@g****m 227
Harald Eggen h****g@e****m 146
Muhammad Usama 1****K 125
Zohar Malamant Z****M@e****m 105
eq-sandkav s****v@e****m 88
Anna Kvashchuk k****a@g****m 51
Fredrik Mellemstrand f****l@e****m 33
dependabot[bot] 4****] 17
Sviatoslav Eroshkin 1****e 8
Olve Maudal o****m@e****m 7
snyk-bot s****t@s****o 7
Daniel Vieira k****e@p****r 4
danielsantiago1002 d****2@h****m 1
Benjamin Williamson b****n@n****o 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 193
Total pull requests: 360
Average time to close issues: 3 months
Average time to close pull requests: 10 days
Total issue authors: 8
Total pull request authors: 14
Average comments per issue: 0.65
Average comments per pull request: 0.36
Merged pull request: 229
Bot issues: 0
Bot pull requests: 20

Past year issues: 69
Past year pull requests: 152
Past year average time to close issues: 3 months
Past year average time to close pull requests: 8 days
Past year issue authors: 5
Past year pull request authors: 10
Past year average comments per issue: 0.91
Past year average comments per pull request: 0.38
Past year merged pull request: 116
Past year bot issues: 0
Past year bot pull requests: 20

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/equinor/acidwatch

Top Issue Authors

  • kvashchuka (87)
  • lars-petter-hauge (38)
  • haralde (31)
  • SAKavli (17)
  • pinkwah (15)
  • fmell (2)
  • Hardins (2)
  • danielsantiago1002 (1)

Top Pull Request Authors

  • lars-petter-hauge (102)
  • haralde (57)
  • SAKavli (45)
  • pinkwah (44)
  • UsamaEquinorAFK (30)
  • kvashchuka (26)
  • dependabot[bot] (20)
  • fmell (17)
  • Sviatose (6)
  • Hardins (5)
  • olvemaudal (2)
  • fhdiaze (1)
  • Copilot (1)
  • badw (1)

Top Issue Labels

  • need-discussion (7)
  • bug (6)
  • blocked (6)
  • good first issue (3)
  • v0.1 (2)
  • frontend (2)
  • metrics (1)
  • summer (1)
  • epic (1)

Top Pull Request Labels

  • dependencies (20)
  • python:uv (11)
  • javascript (7)
  • python (2)

Dependencies

.github/workflows/javascript.yaml actions
  • actions/checkout v4 composite
  • actions/setup-node v3 composite
.github/workflows/python-pgsql.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • postgres * docker
.github/workflows/python.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
frontend/package-lock.json npm
  • 762 dependencies
frontend/package.json npm
  • @eslint/js ^9.13.0 development
  • @types/plotly.js-basic-dist ^1.54.4 development
  • @types/react ^18.3.11 development
  • @types/react-dom ^18.3.1 development
  • @types/react-plotly.js ^2.6.3 development
  • @vitejs/plugin-react ^4.3.3 development
  • eslint ^9.15.0 development
  • eslint-plugin-react-hooks ^5.0.0 development
  • eslint-plugin-react-refresh ^0.4.13 development
  • globals ^15.11.0 development
  • prettier ^3.3.3 development
  • typescript ~5.6.2 development
  • typescript-eslint ^8.10.0 development
  • vite ^5.4.9 development
  • @azure/msal-browser ^3.26.1
  • @azure/msal-react ^2.1.1
  • @equinor/eds-core-react latest
  • @equinor/eds-data-grid-react latest
  • @microsoft/applicationinsights-react-js ^17.3.4
  • @microsoft/applicationinsights-web ^3.3.4
  • @microsoft/mgt ^4.4.0
  • @microsoft/mgt-msal-provider ^2.11.2
  • @microsoft/mgt-msal2-provider ^4.4.0
  • @microsoft/mgt-react ^4.4.0
  • @tanstack/react-query ^5.59.16
  • axios ^1.7.8
  • plotly.js ^2.9.0
  • plotly.js-basic-dist ^2.35.2
  • react ^18.3.1
  • react-dom ^18.3.1
  • react-modal ^3.16.1
  • react-plotly.js ^2.6
  • react-router-dom ^6.27.0
  • zustand ^5.0.0
backend/pyproject.toml pypi
  • flake8 ^7.1.1 develop
  • flake8-bugbear ^24.10.31 develop
  • pytest ^6.2.2 develop
  • azure-cosmos ^4.9.0
  • azure-identity ^1.19
  • fastapi ^0.115.5
  • httpx ^0.27.2
  • msal ^1.31.1
  • pyjwt ^2.10.1
  • python ^3.9
  • python-dotenv ^1.0.1
  • requests ^2.32.3
  • uvicorn ^0.32.1
backend/Dockerfile docker
  • python 3.11-slim build
frontend/Dockerfile docker
  • docker.io/library/node 22-bookworm-slim build
  • docker.io/nginxinc/nginx-unprivileged alpine build
docker-compose.yml docker
workers/example/Dockerfile docker
  • python 3.13-slim build
.github/workflows/docs.yml actions
  • actions/checkout v6 composite
  • actions/configure-pages v6 composite
  • actions/deploy-pages v5 composite
  • actions/setup-python v6 composite
  • actions/upload-pages-artifact v5 composite
  • astral-sh/setup-uv v5 composite
workers/phpitz-solubility/Dockerfile docker
  • python 3.13-slim build
workers/srk-vanlaar/Dockerfile docker
  • python 3.13-slim build
workers/gibbs-minimization/uv.lock pypi
  • acidwatch-messaging 0.1.0
  • acidwatch-models 0.1.0
  • acidwatch-worker-gibbs-minimization 0.1.0
  • acidwatch-worker-runtime 0.1.0
  • aio-pika 10.0.1
  • aiormq 7.0.0
  • annotated-types 0.8.0
  • anyio 4.14.2
  • azure-core 1.41.0
  • azure-servicebus 7.14.3
  • certifi 2026.7.22
  • charset-normalizer 3.5.1
  • colorama 0.4.6
  • h11 0.16.0
  • httpcore 1.0.9
  • httpx 0.28.1
  • idna 3.19
  • iniconfig 2.3.0
  • isodate 0.7.2
  • jpype1 1.7.1
  • markdown 3.10.3
  • multidict 6.7.1
  • neqsim 3.1.0
  • nh3 0.3.6
  • numpy 2.5.2
  • packaging 26.3
  • pamqp 4.0.1
  • pandas 2.3.3
  • pluggy 1.6.0
  • propcache 0.5.2
  • pydantic 2.13.4
  • pydantic-core 2.46.4
  • pygments 2.21.0
  • pytest 9.1.1
  • pytest-asyncio 1.4.0
  • python-dateutil 2.9.0.post0
  • pytz 2026.3.post1
  • requests 2.34.2
  • six 1.17.0
  • typing-extensions 4.16.0
  • typing-inspection 0.4.4
  • tzdata 2026.3
  • urllib3 2.7.0
  • yarl 1.24.5
.devcontainer/Dockerfile docker
  • mcr.microsoft.com/vscode/devcontainers/base ubuntu build
workers/tocomo/Dockerfile docker
  • python 3.13-slim build
backend/packages/acidwatch/pyproject.toml pypi
  • httpx >=0.28.1
  • pandas >=2.3
  • pydantic >=2.13.3
  • typer >=0.26.7
workers/phpitz-solubility/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
workers/tocomo/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
  • tocomo *
workers/tocomo/uv.lock pypi
  • acidwatch-messaging 0.1.0
  • acidwatch-models 0.1.0
  • acidwatch-worker-runtime 0.1.0
  • acidwatch-worker-tocomo 0.1.0
  • aio-pika 10.0.1
  • aiormq 7.0.0
  • annotated-doc 0.0.5
  • annotated-types 0.8.0
  • anyio 4.14.2
  • azure-core 1.41.0
  • azure-servicebus 7.14.3
  • certifi 2026.7.22
  • charset-normalizer 3.5.1
  • click 8.4.2
  • colorama 0.4.6
  • dnspython 2.8.0
  • email-validator 2.3.0
  • fastapi 0.111.1
  • fastapi-cli 0.0.32
  • h11 0.16.0
  • httpcore 1.0.9
  • httptools 0.8.0
  • httpx 0.28.1
  • idna 3.19
  • iniconfig 2.3.0
  • isodate 0.7.2
  • itsdangerous 2.2.0
  • jinja2 3.1.6
  • markdown 3.10.3
  • markdown-it-py 4.2.0
  • markupsafe 3.0.3
  • mdurl 0.1.2
  • multidict 6.7.1
  • nh3 0.3.6
  • numpy 2.5.2
  • orjson 3.12.0
  • packaging 26.3
  • pamqp 4.0.1
  • pandas 2.3.3
  • pluggy 1.6.0
  • propcache 0.5.2
  • pydantic 2.13.4
  • pydantic-core 2.46.4
  • pydantic-extra-types 2.11.1
  • pydantic-settings 2.15.0
  • pygments 2.21.0
  • pytest 9.1.1
  • pytest-asyncio 1.4.0
  • python-dateutil 2.9.0.post0
  • python-dotenv 1.2.3
  • python-multipart 0.0.32
  • pytz 2026.3.post1
  • pyyaml 6.0.3
  • requests 2.34.2
  • rich 15.0.0
  • rich-toolkit 0.20.3
  • shellingham 1.5.4
  • six 1.17.0
  • starlette 0.37.2
  • tocomo 0.1.0
  • typer 0.27.1
  • typing-extensions 4.16.0
  • typing-inspection 0.4.4
  • tzdata 2026.3
  • ujson 5.13.0
  • urllib3 2.7.0
  • uvicorn 0.30.6
  • uvloop 0.22.1
  • watchfiles 1.2.0
  • websockets 17.0.1
  • yarl 1.24.5
workers/phpitz-solubility/uv.lock pypi
  • acidwatch-messaging 0.1.0
  • acidwatch-models 0.1.0
  • acidwatch-worker-phpitz-solubility 0.1.0
  • acidwatch-worker-runtime 0.1.0
  • aio-pika 10.0.1
  • aiormq 7.0.0
  • annotated-types 0.8.0
  • anyio 4.14.2
  • azure-core 1.41.0
  • azure-servicebus 7.14.3
  • certifi 2026.7.22
  • charset-normalizer 3.5.1
  • h11 0.16.0
  • httpcore 1.0.9
  • httpx 0.28.1
  • idna 3.19
  • isodate 0.7.2
  • markdown 3.10.3
  • multidict 6.7.1
  • nh3 0.3.6
  • pamqp 4.0.1
  • propcache 0.5.2
  • pydantic 2.13.4
  • pydantic-core 2.46.4
  • requests 2.34.2
  • typing-extensions 4.16.0
  • typing-inspection 0.4.4
  • urllib3 2.7.0
  • yarl 1.24.5
.github/workflows/publish-pypi.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v3 composite
workers/srk-vanlaar/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
  • neqsim *
workers/srk-vanlaar/uv.lock pypi
  • acidwatch-messaging 0.1.0
  • acidwatch-models 0.1.0
  • acidwatch-worker-runtime 0.1.0
  • acidwatch-worker-srk-vanlaar 0.1.0
  • aio-pika 10.0.1
  • aiormq 7.0.0
  • annotated-types 0.8.0
  • anyio 4.14.2
  • azure-core 1.41.0
  • azure-servicebus 7.14.3
  • certifi 2026.7.22
  • charset-normalizer 3.5.1
  • h11 0.16.0
  • httpcore 1.0.9
  • httpx 0.28.1
  • idna 3.19
  • isodate 0.7.2
  • jpype1 1.7.1
  • markdown 3.10.3
  • multidict 6.7.1
  • neqsim 3.18.0
  • nh3 0.3.6
  • numpy 2.5.2
  • packaging 26.3
  • pamqp 4.0.1
  • pandas 3.0.5
  • propcache 0.5.2
  • pydantic 2.13.4
  • pydantic-core 2.46.4
  • python-dateutil 2.9.0.post0
  • requests 2.34.2
  • six 1.17.0
  • typing-extensions 4.16.0
  • typing-inspection 0.4.4
  • tzdata 2026.3
  • urllib3 2.7.0
  • yarl 1.24.5
workers/arcs/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
  • arcs *
workers/example/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
pyproject.toml pypi
  • acidwatch *
  • acidwatch-api *
  • griffe-typingdoc >=0.3.1
  • mkdocstrings [python]>=1.0.4
  • zensical >=0.0.46
workers/arcs/uv.lock pypi
  • 192 dependencies
workers/example/uv.lock pypi
  • acidwatch-messaging 0.1.0
  • acidwatch-models 0.1.0
  • acidwatch-worker-example 0.1.0
  • acidwatch-worker-runtime 0.1.0
  • aio-pika 10.0.1
  • aiormq 7.0.0
  • annotated-types 0.8.0
  • anyio 4.14.2
  • azure-core 1.41.0
  • azure-servicebus 7.14.3
  • certifi 2026.7.22
  • charset-normalizer 3.5.1
  • colorama 0.4.6
  • h11 0.16.0
  • httpcore 1.0.9
  • httpx 0.28.1
  • idna 3.19
  • iniconfig 2.3.0
  • isodate 0.7.2
  • markdown 3.10.3
  • multidict 6.7.1
  • nh3 0.3.6
  • packaging 26.3
  • pamqp 4.0.1
  • pluggy 1.6.0
  • propcache 0.5.2
  • pydantic 2.13.4
  • pydantic-core 2.46.4
  • pygments 2.21.0
  • pytest 9.1.1
  • pytest-asyncio 1.4.0
  • requests 2.34.2
  • typing-extensions 4.16.0
  • typing-inspection 0.4.4
  • urllib3 2.7.0
  • yarl 1.24.5
workers/gibbs-minimization/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
  • neqsim ==3.1.0
workers/phpitz-reactive/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
workers/arcs/Dockerfile docker
  • python 3.13-slim build
workers/gibbs-minimization/Dockerfile docker
  • python 3.13-slim build
workers/phpitz-reactive/Dockerfile docker
  • python 3.13-slim build
backend/packages/acidwatch-messaging/pyproject.toml pypi
  • acidwatch-models *
  • aio-pika >=10.0.1
  • azure-servicebus >=7.14.2,<8.0.0
backend/packages/acidwatch-models/pyproject.toml pypi
  • httpx *
  • markdown >=3.10,<4.0
  • nh3 >=0.3,<0.4
  • pydantic *
  • typing-extensions *
uv.lock pypi
  • 213 dependencies
.github/workflows/python-packages.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
workers/phpitz-reactive/uv.lock pypi
  • acidwatch-messaging 0.1.0
  • acidwatch-models 0.1.0
  • acidwatch-worker-phpitz-reactive 0.1.0
  • acidwatch-worker-runtime 0.1.0
  • aio-pika 10.0.1
  • aiormq 7.0.0
  • annotated-types 0.8.0
  • anyio 4.14.2
  • azure-core 1.41.0
  • azure-servicebus 7.14.3
  • certifi 2026.7.22
  • charset-normalizer 3.5.1
  • h11 0.16.0
  • httpcore 1.0.9
  • httpx 0.28.1
  • idna 3.19
  • isodate 0.7.2
  • markdown 3.10.3
  • multidict 6.7.1
  • nh3 0.3.6
  • pamqp 4.0.1
  • propcache 0.5.2
  • pydantic 2.13.4
  • pydantic-core 2.46.4
  • requests 2.34.2
  • typing-extensions 4.16.0
  • typing-inspection 0.4.4
  • urllib3 2.7.0
  • yarl 1.24.5
backend/packages/acidwatch-worker-runtime/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
workers/ccstoolkit/pyproject.toml pypi
  • acidwatch-messaging *
  • acidwatch-models *
  • acidwatch-worker-runtime *
  • ccstoolkit *
workers/ccstoolkit/uv.lock pypi
  • acidwatch-messaging 0.1.0
  • acidwatch-models 0.1.0
  • acidwatch-worker-ccstoolkit 0.1.0
  • acidwatch-worker-runtime 0.1.0
  • aio-pika 10.0.1
  • aiormq 7.0.0
  • annotated-types 0.8.0
  • anyio 4.14.2
  • azure-core 1.41.0
  • azure-servicebus 7.14.3
  • ccstoolkit 0.2.0
  • certifi 2026.7.22
  • charset-normalizer 3.5.0
  • contourpy 1.3.3
  • cycler 0.12.1
  • fonttools 4.63.0
  • h11 0.16.0
  • httpcore 1.0.9
  • httpx 0.28.1
  • idna 3.18
  • isodate 0.7.2
  • kiwisolver 1.5.0
  • markdown 3.10.3
  • matplotlib 3.11.1
  • multidict 6.9.1
  • nh3 0.3.6
  • numpy 2.5.2
  • packaging 26.3
  • pamqp 4.0.1
  • pillow 12.3.0
  • propcache 0.5.2
  • pydantic 2.13.4
  • pydantic-core 2.46.4
  • pyparsing 3.3.2
  • python-dateutil 2.9.0.post0
  • requests 2.34.2
  • scipy 1.18.0
  • six 1.17.0
  • tabulate 0.10.0
  • typing-extensions 4.16.0
  • typing-inspection 0.4.4
  • urllib3 2.8.0
  • yarl 1.24.5
workers/ccstoolkit/Dockerfile docker
  • python 3.13-slim build

Score: 6.194405391104672