Skip to content

Commit

Permalink
Merge pull request #129 from paulsaxe/main
Browse files Browse the repository at this point in the history
Using explicit version of Docker image
  • Loading branch information
seamm authored Feb 10, 2024
2 parents 6530872 + 74f04ad commit 9b90f9f
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
20 changes: 13 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,20 +53,26 @@ Features
seamm-mopac Docker image
------------------------
There is a Docker image available for the SEAMM MOPAC plug-in for running mopac. It is
available at
available at the Github Container Registry (ghcr.io) as

.. code-block:: bash
ghcr.io/molssi-seamm/seamm-mopac:latest
ghcr.io/molssi-seamm/seamm-mopac:<version>
It can also be run standalone with the following command:
Where <version> is the explicit version tag for the desired image. The tag `latest` is
quite confusing, and does not mean the latest version of the image, so we recomend using
explcit versions rather than `latest`.

The container can also be run standalone with the following command:

.. code-block:: bash
docker run --rm -v $PWD:/home ghcr.io/molssi-seamm/seamm-mopac:latest <input file>
docker run --rm -v $PWD:/home ghcr.io/molssi-seamm/seamm-mopac:<version> ?mopac <input file>?
where `<input file>` is the input file for the MOPAC calculation. By default, the input
file is `mopac.dat`. The output files will be written to the current directory.
where `<input file>` is the input file for the MOPAC calculation. By default, mopac is
run using the input file `mopac.dat`. The output files will be written to the current
directory. The `--rm` option removes the container after it exits, and the `-v` option
mounts the current directory to the `/home` directory in the container.

Acknowledgements
----------------
Expand All @@ -78,7 +84,7 @@ This package was created with Cookiecutter_ and the `molssi-seamm/cookiecutter-s

Developed by the Molecular Sciences Software Institute (MolSSI_),
which receives funding from the `National Science Foundation`_ under
award ACI-1547580
awards OAC-1547580 and CHE-2136142.

.. _MolSSI: https://www.molssi.org
.. _`National Science Foundation`: https://www.nsf.gov
3 changes: 1 addition & 2 deletions devtools/docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ COPY ./environment.yml /root/environment.yml
RUN mamba env update -f /root/environment.yml

WORKDIR /home
ENTRYPOINT ["mopac"]
CMD ["mopac.dat"]
CMD ["mopac", "mopac.dat"]
2 changes: 1 addition & 1 deletion mopac_step/data/mopac.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ conda-environment = seamm-mopac
code = mopac

# The name and location of the Docker container to use, optionally with the version
container = ghcr.io/molssi-seamm/seamm-mopac:latest
container = ghcr.io/molssi-seamm/seamm-mopac:{version}

2 changes: 2 additions & 0 deletions mopac_step/mopac.py
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,8 @@ def run(self, printer=printer):
}

config = dict(full_config.items(executor_type))
# Use the matching version of the seamm-mopac image by default.
config["version"] = self.version

return_files = [
"mopac.arc",
Expand Down

0 comments on commit 9b90f9f

Please sign in to comment.