Skip to content

Commit 99213e6

Browse files
committed
Production/Stable
* automatic exclusion of atoms with zero radius from surface analysis (this creates artefacts especially with the triangulation in GITIM) * updated documentation * Chacon-Tarazona support removed (contact developers to reintroduce it if needed) * ready for integration in MDAKits (see https://github.com/MDAnalysis/MDAKits) * version bump to 1.0.0
1 parent 6be94f0 commit 99213e6

25 files changed

+277
-399
lines changed

AUTHORS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Marcello-Sega https://api.github.com/users/Marcello-Sega
2+
gyorgy-hantal https://api.github.com/users/gyorgy-hantal
3+
balazsfabian https://api.github.com/users/balazsfabian
4+
elija-feigl https://api.github.com/users/elija-feigl
5+
JakobMichl https://api.github.com/users/JakobMichl
6+
iuvenis https://api.github.com/users/iuvenis
7+
bnovak1 https://api.github.com/users/bnovak1

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ So far the following interface/phase identification methods have been implemente
2626
* GITIM
2727
* SASA
2828
* Willard Chandler
29-
* Chacon Tarazona
3029
* DBSCAN filtering
3130

3231
## Supported formats
@@ -475,7 +474,5 @@ Depending on which algorithm you are using, you might also want to cite the foll
475474

476475
[M. Sega and G. Hantal._Phys. Chem. Chem. Phys._ **29**, 18968-18974 (2017)](https://doi.org/10.1039/C7CP02918G) Phase and interface determination in computer simulations of liquid mixtures with high partial miscibility.
477476

478-
[E. Chacón, P. Tarazona, Phys. Rev. Lett. **91**, 166103 (2003)](http://dx.doi.org/10.1103/PhysRevLett.91.166103) Intrinsic profiles beyond the capillary wave theory: A Monte Carlo study.
479-
480477
[A. P. Willard, D. Chandler, J. Phys. Chem. B **114**,1954 (2010)](http://dx.doi.org/10.1021/jp909219k) Instantaneous Liquid Interfaces
481478

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ So far the following methods have been implemented:
1212

1313
* ITIM
1414
* GITIM
15+
* SASA
1516
* Willard Chandler
16-
* Chacon Tarazona
1717
* DBSCAN filtering
1818

1919
----

docs/source/ChaconTarazona.rst

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

docs/source/SASA.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
SASA
2+
****
3+
4+
.. include:: refs.rst
5+
6+
.. automodule:: pytim.sasa
7+
:members: SASA
8+
:inherited-members:
9+
:member-order: bysource
10+
:exclude-members: LayerAtomGroup, alpha,cluster_cut, cluster_threshold_density,extra_cluster_groups,info,itim_group,max_layers,molecular,multiproc,radii_dict,save_pdb, surfaces
11+
12+
* :ref:`genindex`
13+
* :ref:`modindex`
14+
* :ref:`search`
15+
16+
.. raw:: html
17+
:file: analytics.html
18+

docs/source/Tutorials.rst

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

docs/source/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,16 @@
7777
# built documents.
7878
#
7979
# The short X.Y version.
80-
version = u'0.7'
80+
version = u'1.0'
8181
# The full version, including alpha/beta/rc tags.
82-
release = u'0.7.0'
82+
release = u'1.0.0'
8383

8484
# The language for content autogenerated by Sphinx. Refer to documentation
8585
# for a list of supported languages.
8686
#
8787
# This is also used if you do content translation via gettext catalogs.
8888
# Usually you set "language" from the command line for these cases.
89-
language = None
89+
language = 'en'
9090

9191
# There are two options for replacing |today|: either, you set today to some
9292
# non-false value, then it is used:

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323

2424
ITIM
2525
GITIM
26+
SASA
2627
WillardChandler
27-
ChaconTarazona
2828
SimpleInterface
2929
observables
3030
datafiles

docs/source/install.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ The package will download all the dependencies which are needed. Prerequisites f
1717

1818
.. code-block:: bash
1919
20-
pip install setuptools --user --upgrade
21-
pip install numpy --user --upgrade
22-
pip install cython --user --upgrade
23-
2420
git clone https://github.com/Marcello-Sega/pytim.git
2521
cd pytim
2622
python setup.py install --user
@@ -35,12 +31,22 @@ The package can also be installed directly from the Python Package Index, along
3531

3632
.. code-block:: bash
3733
38-
pip install setuptools --user --upgrade
39-
pip install cython --user --upgrade
40-
pip install numpy --user --upgrade
41-
34+
git clone https://github.com/Marcello-Sega/pytim.git
35+
cd pytim
4236
pip install pytim --user --upgrade
4337
38+
39+
Alternatively, you can use pip (directly or as a module) to install pytim, possibly in developer/editable mode:
40+
41+
.. code-block:: bash
42+
43+
git clone https://github.com/Marcello-Sega/pytim.git
44+
cd pytim
45+
python -m pip install -e .
46+
47+
This way the changes in the source will be reflected immediately after restarting a python shell, avoiding the need to reinstall every time.
48+
49+
4450
Using Anaconda
4551
--------------
4652

docs/source/observables.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Radial Distribution Functions
66
#############################
77
.. automodule:: pytim.observables.rdf
88
:members:
9+
.. automodule:: pytim.observables.rdf2d
10+
:members:
911

1012
Profiles
1113
########
@@ -17,11 +19,32 @@ Time Correlation Functions
1719
.. autoclass:: pytim.observables.Correlator
1820
:members:
1921

22+
Contact Angles
23+
##############
24+
.. autoclass:: pytim.observables.ContactAngle
25+
:members:
26+
27+
3D Distributions
28+
################
29+
.. autoclass:: pytim.observables.DistributionFunction
30+
:members:
31+
32+
Free Volume
33+
###########
34+
.. autoclass:: pytim.observables.FreeVolume
35+
:members:
36+
37+
Local Reference Frame
38+
#####################
39+
40+
2041
Misc
2142
####
43+
.. autoclass:: pytim.observables.IntrinsicDistance
44+
:members:
2245
.. autoclass:: pytim.observables.LayerTriangulation
2346
:members:
24-
.. autoclass:: pytim.observables.IntrinsicDistance
47+
.. autoclass:: pytim.observables.LocalReferenceFrame
2548
:members:
2649

2750

0 commit comments

Comments
 (0)