Skip to content

Commit

Permalink
preparation for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
quaquel committed Dec 22, 2018
1 parent a2b0e07 commit 667c3c8
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 12 deletions.
17 changes: 17 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@


Changelog
=========


Version 0.3
-----------
- new repeat_report method
- load_model now raises a FileNotFoundError if the model can't be found
- use temporary folders created by tempfile module in repeat_report (contributed by tfrench)
- extensions now no longer need to be copied to the model directory (contributed by tfrench)
- addition keyword argument on init of PyNetLogo link for passing
additional arguments to jvm
- additional documentation


4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Documentation
./_docs/introduction.ipynb
./_docs/SALib_ipyparallel.ipynb
./_docs/SALib_multiprocessing.ipynb
Core module documentation <./_docs/pynetlogo.rst>

Detailed Documentation <./_docs/pynetlogo.rst>
Changelog <./changelog.rst>


Indices and tables
Expand Down
22 changes: 16 additions & 6 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
Installation
============

pyNetLogo requires the NumPy, SciPy and pandas packages, which are included in most scientific Python distributions. The module has been tested using the Continuum Anaconda 2.7 and 3.6 64-bit distributions.
pyNetLogo requires the NumPy, SciPy and pandas packages, which are
included in most scientific Python distributions. The module has been
tested using the Continuum Anaconda 2.7 and 3.6 64-bit distributions.

In addition, pyNetLogo depends on `JPype <https://jpype.readthedocs.io/en/latest/>`_. Please follow the instructions provided there to install JPype; the conda package manager usually provides the easiest option.
In addition, pyNetLogo depends on `JPype <https://jpype.readthedocs.io/en/latest/>`_.
Please follow the instructions provided there to install JPype; the conda
package manager usually provides the easiest option.

pyNetLogo can be installed using the pip package manager, with the following command from a terminal:
pyNetLogo can be installed using the pip package manager, with the
following command from a terminal:

``pip install pynetlogo``

By default, pyNetLogo and Jpype will attempt to automatically identify the NetLogo version and installation directory on Mac or Windows, as well as the Java home directory. On Linux, or in case of issues (e.g. if NetLogo was installed in a different directory, or if the Java path is not found on a Mac), these parameters can be passed directly to the NetLogoLink class as described in the module documentation.
By default, pyNetLogo and Jpype will attempt to automatically identify
the NetLogo version and installation directory on Mac or Windows, as well
as the Java home directory. On Linux, or in case of issues (e.g. if NetLogo
was installed in a different directory, or if the Java path is not found on a
Mac), these parameters can be passed directly to the NetLogoLink class as
described in the module documentation.

Known bugs and limitations
--------------------------
Expand All @@ -19,5 +29,5 @@ Known bugs and limitations
using the `Python extension for NetLogo <https://github.com/qiemem/PythonExtension>`_.
- See `JPype limitations <https://jpype.readthedocs.io/en/latest/install.html#known-bugs-limitations>`_
for additional limitations.
- Mixing 32-bit and 64-bit versions of Java, Python, and NetLogo will crash
Python.
- Mixing 32-bit and 64-bit versions of Java, Python, and NetLogo will
crash Python.
2 changes: 1 addition & 1 deletion pyNetLogo/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from .core import *

__version__ = '0.2.2'
__version__ = '0.3'
6 changes: 3 additions & 3 deletions pyNetLogo/core.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
To do: check Mac support and handling of custom directories
"""

Expand All @@ -19,8 +19,8 @@
import warnings


__all__ = ['NetLogoException',
'NetLogoLink']
__all__ = ['NetLogoLink',
'NetLogoException']

PYNETLOGO_HOME = os.path.dirname(os.path.abspath(__file__))

Expand Down

0 comments on commit 667c3c8

Please sign in to comment.