Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
openstructure
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container registry
Model registry
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
schwede
openstructure
Commits
7d203cdd
Verified
Commit
7d203cdd
authored
1 month ago
by
Xavier Robin
Browse files
Options
Downloads
Patches
Plain Diff
doc: how to properly install OST
parent
c49bc738
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
modules/doc/install.rst
+39
-6
39 additions, 6 deletions
modules/doc/install.rst
with
39 additions
and
6 deletions
modules/doc/install.rst
+
39
−
6
View file @
7d203cdd
...
@@ -22,6 +22,7 @@ the steps which we describe in detail below. In essence, these steps are:
...
@@ -22,6 +22,7 @@ the steps which we describe in detail below. In essence, these steps are:
* `Building the Project`_
* `Building the Project`_
* `Building the Compound Library`_
* `Building the Compound Library`_
* `Running the tests`_
* `Running the tests`_
* `Installing OpenStructure`_
Installing the Dependencies
Installing the Dependencies
...
@@ -379,6 +380,41 @@ Many parts of OpenStructure are covered by unit tests. You can run them with:
...
@@ -379,6 +380,41 @@ Many parts of OpenStructure are covered by unit tests. You can run them with:
stage/bin/ost doc/make.py
stage/bin/ost doc/make.py
Installing OpenStructure
--------------------------------------------------------------------------------
To make OpenStructure available system-wide, the easiest is to install it with:
.. code-block:: bash
make install
This will install the OpenStructure binaries and libraries to the prefix
folder specified by `CMAKE_INSTALL_PREFIX` in the cmake configuration step
(usually this will be `/usr/local`).
In many distributions (such as Ubuntu), libraries are not picked up
automatically from `/usr/local` so you will need to export a few environment
variables to make things work:
.. code-block:: bash
export OST_ROOT="/usr/local"
export PYTHONPATH="/usr/local/lib64/python3.10/site-packages"
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib64:/usr/local/openmm/lib/"
If you don't want to install OpenStructure system-wide, for instance if this is
a development build, you can also configure environment variables to point
directly to the `stage` folder.
.. code-block:: bash
export OST_ROOT=/path/to/ost/stage
export PATH=$OST_ROOT/bin:$PATH
export PYTHONPATH=$OST_ROOT/lib64/python3.10/site-packages/:$PYTHONPATH
What's next?
What's next?
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
...
@@ -387,26 +423,23 @@ all located in stage/bin:
...
@@ -387,26 +423,23 @@ all located in stage/bin:
.. code-block:: bash
.. code-block:: bash
stage/bin/
dng
dng
or, to start the command-line interpreter:
or, to start the command-line interpreter:
.. code-block:: bash
.. code-block:: bash
stage/bin/
ost
ost
The `ost` executable can run python scripts. For instance we can run the Docker
The `ost` executable can run python scripts. For instance we can run the Docker
test script:
test script:
.. code-block:: bash
.. code-block:: bash
stage/bin/
ost docker/test_docker.py
ost docker/test_docker.py
This should produce some output and announce that "OST is working!"
This should produce some output and announce that "OST is working!"
If you repeatedly use OpenStructure, it is recommended to add
/path/to/ost/stage/bin to your path.
You can also import OpenStructure directly into your existing python scripts,
You can also import OpenStructure directly into your existing python scripts,
jupyter notebooks etc. Simply make sure to point the following environment
jupyter notebooks etc. Simply make sure to point the following environment
variables to the right folders:
variables to the right folders:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment