Skip to content

Commit

Permalink
Update docs w/ PyPI info
Browse files Browse the repository at this point in the history
  • Loading branch information
godotalgorithm committed Feb 25, 2025
1 parent 05637f0 commit 9c23b03
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Installation
============

Mopactools will soon be available on PyPI and conda-forge, which will handle all aspects of the installation. In particular,
they will package copies of the MOPAC shared library for convenient use within the Python software ecosystem.
Mopactools is available on PyPI and can be installed using a standard ``pip install mopactools``. The PyPI distribution
includes a copy of the MOPAC shared library. Mopactools will also be available on the conda-forge channel of the Conda package
manager in the near future.

Otherwise, mopactools can be installed locally using a standard ``pip install .`` command in the root of the source directory.
For mopactools to function correctly, it must be able to find the MOPAC shared library in the system path or in the ``lib``
subdirectory of the installed package directory. If a copy of the MOPAC shared library is placed into the ``lib`` subdirectory
of the source package, then the ``pip install .`` command will create another copy in the installed package directory.
Otherwise, mopactools can be installed locally from a clone of its GitHub repository using a standard ``pip install .`` command
in the root of the source directory. For mopactools to function correctly, it must be able to find the MOPAC shared library in
the system path or in the ``lib`` subdirectory of the installed package directory. If a copy of the MOPAC shared library is
placed into the ``lib`` subdirectory of the source package, then the ``pip install .`` command will create another copy in the
installed package directory.

0 comments on commit 9c23b03

Please sign in to comment.