Skip to content

Commit 0a188f7

Browse files
committed
Changes and fixes for the release repo
1 parent ef236a1 commit 0a188f7

12 files changed

Lines changed: 8 additions & 764 deletions

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,3 @@ used to communicate with the MOFplus website.
3737
:caption: Technical Documentation
3838

3939
tech_api
40-
webserver_management

docs/tech_api.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,3 @@ FF API
1919
:show-inheritance:
2020
:members:
2121

22-
ADMIN API
23-
---------
24-
.. autoclass:: mofplus.admin.admin_api
25-
:show-inheritance:
26-
:members:

docs/user_download_and_install.rst

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,9 @@ Download the code
1212

1313
The latest stable source code release can be downloaded here:
1414

15-
https://www.mofplus.org
16-
17-
Choose a suitable directory, download and unpack the archive
18-
19-
20-
.. code-block:: bash
21-
22-
curl -kLO https://www.mofplus.org
23-
tar -xvzf mofplus.tar.gz
24-
cd mofplus
25-
26-
As alternatice you can get the most recent version by cloning its git repository:
27-
2815
.. code-block:: bash
2916
30-
git clone https://github.com/MOFplus
17+
git clone https://github.com/mofplus_rel
3118
3219
3320
Dependencies
@@ -50,13 +37,7 @@ Installation
5037
------------
5138

5239
In order to install the MOFplus API on your system you have to make sure that the
53-
mofplus/mofplus directory is in the PYTHONPATH of your system. The easiest way
54-
to do so is to use the ``setup.py`` script. To install, invoke the following
55-
command:
56-
57-
.. code-block:: bash
58-
59-
python setup.py install
40+
mofplus/mofplus directory is in the PYTHONPATH of your system.
6041

6142
If you want to compile the documentation switch to the docs directory and type the follwoing
6243
commands:

docs/user_getted_started.rst

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ email adress and password.
3636
Programm Structure
3737
------------------
3838

39-
The MOFplus API package is divided into three modules holding three
39+
The MOFplus API package is divided modules
4040

4141
#. module ``user`` with class ``user_api``.
4242
Here all methods for querying
@@ -46,14 +46,7 @@ The MOFplus API package is divided into three modules holding three
4646
setting force field parameters and reference data are available.
4747
The ``ff_api`` class is inherited from the ``user_api`` class. So all
4848
methods implemented in ``user_api`` are also available in ``ff_api``.
49-
#. module ``admin`` with class ``admin_api``.
50-
Here all methods concerning administrating and maintainings the
51-
MOFplus database are implemented. This class is only available
52-
for those MOFplus users which have administrator permissions.
53-
The ``admin_api`` class is inherited from the ``ff_api`` class. So all
54-
methods implemented in ``user_api`` and ``ff_api`` are also available
55-
in ``admin_api``.
56-
49+
5750

5851
Using the API
5952
-------------
@@ -73,15 +66,9 @@ in the following examples:
7366
>> import mofplus
7467
>> api = mofplus.FF_api()
7568
76-
.. code-block:: python
77-
78-
>> import mofplus
79-
>> api = mofplus.admin_api()
80-
8169
The api object can then be used for example to download a topology
8270
stored at MOFplus.
8371

8472
.. code-block:: python
8573
86-
>> import mofplus
8774
>> api.get_net("tbo")

docs/webserver_management.rst

Lines changed: 0 additions & 39 deletions
This file was deleted.

mofplus/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from .user import user_api
66
from .ff import FF_api
7-
from .admin import admin_api
7+
# from .admin import admin_api
88

99
def git_revision_hash():
1010
wrk_dir = os.getcwd()
@@ -25,4 +25,5 @@ def git_revision_hash():
2525
__version_info__ = (0, 0, rev_no, "%s"%commit)
2626
__version__ = "%i.%i.%i.%s"%__version_info__
2727

28-
__all__ = ["user_api", "FF_api", "admin_api"]
28+
# __all__ = ["user_api", "FF_api", "admin_api"] admin_api removed in release repo (RS)
29+
__all__ = ["user_api", "FF_api"]

0 commit comments

Comments
 (0)