Quickstart

Basic Installation

Install directly from the repository:

# Typical install
$ pip install \
  "mcmas @ git+https://github.com/mattvonrocketstein/py-mcmas@v1.0"

# Optional AI Stuff: camel, openai
$ pip install \
  "mcmas[ai] @ git+https://github.com/mattvonrocketstein/py-mcmas@v1.0"

# Other Experimental Stuff: pymodelchecking
$ pip install \
  "mcmas[ai] @ git+https://github.com/mattvonrocketstein/py-mcmas@v1.0"

Running with Docker

See this section for details about building/testing the container.

# Pull the container
$ docker pull ghcr.io/mattvonrocketstein/py-mcmas:main

Note that the docker container for pymcmas still uses docker to interact with the mcmas engine! So you'll want to share the socket. Usually you'll also want a volume for the working directory to share files.

# Run spec from file
$ docker run -it \
    -v `pwd`:/tests -w /tests \
    -v /var/run/docker.sock:/var/run/docker.sock \
    ghcr.io/mattvonrocketstein/py-mcmas:main \
        ./tests/data/minimal.ispl

Note that the default entrypoint for the container is the ispl command, but the mcmas command is also available.

For Developers

For development on compose.mk itself, here's how you can clone the project, build related containers, and run the test suites.

# Clone
$ git clone https://github.com/mattvonrocketstein/py-mcmas

# Build docs
$ make docs

# Do everything else
$ make clean init normalize validate test

# Build pymcmas container
$ make docker.pymcmas.build

# Run main test-suite, inside the container
$ make docker.pymcmas.test