Skip to main content

libAntimony

GitHub version Build Status PyPI version License

PyPI - Downloads Funding Funding Funding Funding Funding

Summary

Antimony is a human-readable, human-writable modular model definition language, letting you create SBML models with a simple text interface, i.e.

   S1 -> S2; k1*S1;
   S2 -> S3; k2*S2;
   S1 = 10
   k1 = 0.3
   k2 = 0.1

For a working online example, see MakeSBML

Antimony is free to use in any application: a simple API is provided to allow Antimony strings to be converted to and from SBML, so the application's users can interact with their models in an easy-to-comprehend format. C/C++ applications can use the library directly, and Python applications can use the Python bindings.

Documentation can be found:

Since Antimony is used within Tellurium, the general Tellurium documentation may also be of interest.

Python bindings are available via pypi, and can be installed with pip:

pip install antimony

Other binaries are available from https://github.com/sys-bio/antimony/releases

Antimony depends on the libSBML and SBMLNetwork libraries. The currently-used versions of each will always be available from https://github.com/sys-bio/libroadrunner-deps/releases/.

Antimony has been supported by NIH/NIGMS Grants GM081070, GM123032, and NIBIB EB028887.

Building from Source

Here we describe how to build libAntimony from source. Note: if these instructions don't work for any reason, look at the github build instructions, which will always be up-to-date out of necessity.

Install Required Build Tools

Install CMake. On Windows, you also need to install Visual Studio with the Desktop development with C++ workload, which enables you to run CMake from an MSVC x64 development environment.

To build the Python bindings, install Python and ensure that CMake can locate it.

To build the QtAntimony (the standalone Antimony editor), install Qt 5.15 (or a later version of Qt5) and ensure that CMake can locate it.

If you are actually developing Antimony, you will need the Bison parser to re-generate src/antimony.tab.cpp from src/antimony.ypp when the latter changes.

Download Prebuilt Dependencies

Download the latest version of prebuilt Antimony dependencies that match your operating system, and build type from the libroadrunner-deps releases page. Make sure you get the 'release' version if you are building the release version of Antimony.

If no pre-built dependencies match your operating system, you'll need to find libsbml with the released packages enabled (in particular: comp, fbc, and distrib) and SBMLNetwork. Libsbml in turn requires an XML library; we recommend using expat. A CMake system that builds these and a few others is available at libroadrunner-deps; see that repository (and its github build files) for more information.

Obtain Antimony Source Code

Clone the Antimony repository and enter the source directory:

git clone https://github.com/sys-bio/antimony.git
cd antimony

Configure with CMake

From the command line (i.e. PowerShell in an MSVC x64 development environment, or a terminal window in MacOS or Linux), enter the following. Replace /path/to/libroadrunner-deps-install with the location of the extracted prebuilt dependencies.

Windows

cmake -S . -B build-antimony `
  -DCMAKE_INSTALL_PREFIX="./install-antimony" `
  -DANT_DEPENDENCIES_INSTALL_PREFIX="C:/path/to/libroadrunner-deps-install" `
  -DCMAKE_BUILD_TYPE=Release `
  -DWITH_PYTHON=ON `
  -DWITH_QTANTIMONY=OFF `
  -DWITH_GTEST=OFF 

MacOS/Linux

cmake -S . -B build-antimony \
  -DCMAKE_INSTALL_PREFIX="./install-antimony" \
  -DANT_DEPENDENCIES_INSTALL_PREFIX="/path/to/libroadrunner-deps-install" \
  -DCMAKE_BUILD_TYPE=Release \
  -DWITH_PYTHON=ON \
  -DWITH_QTANTIMONY=OFF \
  -DWITH_GTEST=OFF 

Making changes

The above represents a typical build, but modifications are available:

  • If you want to compile for a different architecture than the environment where you're running CMake, use (for example) -A x86 or DCMAKE_OSX_ARCHITECTURES="$(uname -m)
  • If you do want to build QTAntimony, change WITH_QTANTIMONY to ON, and set QT5_DIR to the location of the CMake files where you installed QT5 (i.e. Qt5.15.16/5.15.16/msvc2019_64/lib/cmake/Qt5).
  • If you don't want the python bindings, change WITH_PYTHON to OFF.
  • If you want to build the tests, change WITH_GTEST to ON

Build and Install

Windows

cmake --build build-antimony --config Release --target install --parallel

macOS and Linux

cmake --build build-antimony --target install --parallel

Location of files

The compiled files will be installed in the install-antimony directory. This directory should now include:

  • Antimony libraries in lib,
  • Public C/C++ header files in include,
  • If WITH_PYTHON=ON, Python bindings in bindings/python. This directory can be used to build a Python wheel (see these instructions),
  • If WITH_QTANTIMONY=ON, the QtAntimony graphical application in bin.

Metadata

Release files for antimony 3.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for antimony 3.2.1
File Actions
antimony-3.2.1-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for antimony-3.2.1-py3-none-win_amd64.whl
antimony-3.2.1-py3-none-manylinux_2_28_x86_64.whl Python 3 none Linux glibc 2.28+ x86-64 Details for antimony-3.2.1-py3-none-manylinux_2_28_x86_64.whl
antimony-3.2.1-py3-none-macosx_15_0_x86_64.whl Python 3 none macOS 15.0+ x86-64 Details for antimony-3.2.1-py3-none-macosx_15_0_x86_64.whl
antimony-3.2.1-py3-none-macosx_14_0_arm64.whl Python 3 none macOS 14.0+ ARM64 Details for antimony-3.2.1-py3-none-macosx_14_0_arm64.whl

Total release size: 15.3 MB

Release files / antimony-3.2.1-py3-none-win_amd64.whl

Download URL antimony-3.2.1-py3-none-win_amd64.whl
Size 2.6 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
90a571436c5a2a2467f4d168e94db89ebc89b213893f58f5ce73acc3bea084ee
BLAKE2b-256 checksum
How to use checksums
62f4c295ed08411b39a794e24e6fe496a3c5ca692d4a84faba503b3765b34c17
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / antimony-3.2.1-py3-none-manylinux_2_28_x86_64.whl

Download URL antimony-3.2.1-py3-none-manylinux_2_28_x86_64.whl
Size 5.5 MB
Tags Linux glibc 2.28+ x86-64 Python 3
SHA-256 checksum
How to use checksums
0be70fa3f20fa068a9898fa6e7a2a1146b34f745906d02e36713cc4afa9e563e
BLAKE2b-256 checksum
How to use checksums
45370d76c0db1a274e06c7d95f698d0e7735623f16475acbeab3b0843ed29581
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / antimony-3.2.1-py3-none-macosx_15_0_x86_64.whl

Download URL antimony-3.2.1-py3-none-macosx_15_0_x86_64.whl
Size 3.6 MB
Tags Python 3 macOS 15.0+ x86-64
SHA-256 checksum
How to use checksums
70908672b58a74d33e7a7fd7f1f5a9d04b1955ed88c4982bd5c5284619dc3e62
BLAKE2b-256 checksum
How to use checksums
acac1f255598465ef4c624682650fdd15bc366e7987431af6f00a2386133b520
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / antimony-3.2.1-py3-none-macosx_14_0_arm64.whl

Download URL antimony-3.2.1-py3-none-macosx_14_0_arm64.whl
Size 3.6 MB
Tags Python 3 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
2f02a690cfe4e0648ed57dd3721bd5cca48dbeca8563797bb3fd8283cf00deed
BLAKE2b-256 checksum
How to use checksums
554845f06cd7bf16b057b295eed2981402a070aa380be5da8607d7045d9a2b79
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Security for antimony 3.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page