diff --git a/INSTALL b/INSTALL index ba1c985e..8630926c 100644 --- a/INSTALL +++ b/INSTALL @@ -21,6 +21,3 @@ Installation is performed using the command: Assimulo is then installed under Python dist-packages. To test the installation, run "pytest". - -For more information regarding Assimulo and the installation procedure, -please visit: http://www.jmodelica.org/assimulo diff --git a/README.md b/README.md index edad502d..ab31008b 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,6 @@ The package comes with a Problem specifications class and subclasses correspondi To define and solve a problem, first import the solver of choice and the appropriate `Implicit`/`Explicit` class. Furthermore, define your function $f$ and the initial conditions to pass to the problem class constructor. Then, create your solver, set the attributes (method, absolute/relative tolerance etc.) and use the simulate method to simulate. -For more information about Assimulo, documentation tutorial etc, see -the docs from the older [JModelica](http://www.jmodelica.org/assimulo) website. - Sundials Compliance ------------------- Current Assimulo development aims for compliancy with Sundials [v2.7.0](https://github.com/LLNL/sundials/releases/tag/v2.7.0). @@ -23,7 +20,13 @@ Some optional features in `Assimulo>=3.4.1`` are built on the modified Sundials Installation ------------------- -See the INSTALL file or the installation page on http://www.jmodelica.org/assimulo. +The recommended way to install Assimulo is through CONDA. + +`conda install conda-forge::assimulo` + +For installing from source, see the INSTALL file. + +Note that currently the releases on PYPI is outdated. Contributing ------------------- diff --git a/doc/sphinx/source/AssimuloJModelica.png b/doc/sphinx/source/AssimuloJModelica.png deleted file mode 100644 index b1bdc712..00000000 Binary files a/doc/sphinx/source/AssimuloJModelica.png and /dev/null differ diff --git a/doc/sphinx/source/_templates/index.html b/doc/sphinx/source/_templates/index.html index bd47cfdf..9d46a1fd 100644 --- a/doc/sphinx/source/_templates/index.html +++ b/doc/sphinx/source/_templates/index.html @@ -9,9 +9,6 @@

Welcome

Assimulo is created in a collaboration between the Department of Numerical Analysis and the Department of Automatic Control at Lund University together with the company Modelon AB. The main contributors have been Christian Winther (Andersson), Claus Führer, Johan Åkesson and Magnus Gäfvert. For citing Assimulo, see citation.

-

- Assimulo is currently under development and the progress can be followed from our trac-site https://trac.jmodelica.org/assimulo/wiki. -

The following solvers are present, @@ -78,8 +75,8 @@

Documentation

Usage
overview of the attributes

-

JModelica.org
- Assimulo for JModelica.org users

+

PyFMI
+ Assimulo for PyFMI users

Search page
search the documentation

@@ -99,17 +96,14 @@

Download

Assimulo is available for download here. For installation instructions, see here.

The code can be found at - https://trac.jmodelica.org/assimulo/wiki.

+ https://github.com/modelon-community/Assimulo.

-

Contact

-

- Contact us preferably through the forum. -

+

Contribute

- If you like to contribute to the Assimulo project please take a look at the contribution license. + For information about contributing, see https://github.com/modelon-community/contributing.

diff --git a/doc/sphinx/source/contact.rst b/doc/sphinx/source/contact.rst index 48d4dec0..3d8b4b25 100644 --- a/doc/sphinx/source/contact.rst +++ b/doc/sphinx/source/contact.rst @@ -4,4 +4,4 @@ Contact ============= -If you have any questions or comments, contact us preferably through the `forum `_ . +If you have any questions or comments, contact us preferably through `github `_ . diff --git a/doc/sphinx/source/contents.rst b/doc/sphinx/source/contents.rst index 3cf75518..32421fbc 100644 --- a/doc/sphinx/source/contents.rst +++ b/doc/sphinx/source/contents.rst @@ -16,7 +16,7 @@ Contents usage examples - jmodelica + pyfmi download installation code diff --git a/doc/sphinx/source/download.rst b/doc/sphinx/source/download.rst index 7c658359..e4d858c6 100644 --- a/doc/sphinx/source/download.rst +++ b/doc/sphinx/source/download.rst @@ -4,26 +4,17 @@ Download ============= -Current version: +The recommended way to install Assimulo is through `conda `_:: - Available on PyPI, http://pypi.python.org/pypi/Assimulo + conda install conda-forge::assimulo -See :doc:`installation` for instructions on setting up Assimulo. Additionally, Assimulo is available through `conda `_:: +See :doc:`installation` for instructions on installing Assimulo from source. - conda install -c https://conda.binstar.org/chria assimulo - - -To retrieve the latest (develop) version using a subversion software use:: - - svn checkout https://svn.jmodelica.org/assimulo/trunk - - -.. warning:: - - The latest (develop) version may not function properly. +The source code can be found at:: + https://github.com/modelon-community/Assimulo Old versions: - - See, https://trac.jmodelica.org/assimulo/browser/releases + - See, https://github.com/modelon-community/Assimulo/releases diff --git a/doc/sphinx/source/jmodelica.rst b/doc/sphinx/source/jmodelica.rst deleted file mode 100644 index 2bad80fa..00000000 --- a/doc/sphinx/source/jmodelica.rst +++ /dev/null @@ -1,24 +0,0 @@ - - -================================ -Assimulo for JModelica.org users -================================ - - -Assimulo has been incorporated into the JModelica.org platform as the default simulation package. This has been made possible by extending Assimulo's problem classes where the JModelica.org JMI model and FMU model is modified and adapted to Assimulo. In the Figure below the connection between JModelica.org, Assimulo and -Sundials are displayed. - -.. image:: AssimuloJModelica.png - :align: center - - -When using Assimulo together with JModelica.org and the new high-level simulation methods, all the parameters passed in the *options*-dict represents parameters for the specific solver used in Assimulo. :: - - FMUModel(ME1/ME2).simulate(self, - start_time=0.0, - final_time=1.0, - input=(), - algorithm='AssimuloAlg', - options={}): - -A list of the different solver specific parameters can be found in the :doc:`usage` section. A more detailed description of the available options and interface between JModelica.org and Assimulo can be found in the JModelica.org users guide. diff --git a/doc/sphinx/source/pyfmi.rst b/doc/sphinx/source/pyfmi.rst new file mode 100644 index 00000000..b65727ee --- /dev/null +++ b/doc/sphinx/source/pyfmi.rst @@ -0,0 +1,19 @@ + + +================================ +Assimulo for PyFMI users +================================ + + +Assimulo has been incorporated into PyFMI as the default simulation package. This has been made possible by extending Assimulo's problem classes where the FMU model is modified and adapted to Assimulo. + +When using Assimulo together with PyFMI and the new high-level simulation methods, all the parameters passed in the *options*-dict represents parameters for the specific solver used in Assimulo. :: + + FMUModel(ME1/ME2).simulate(self, + start_time=0.0, + final_time=1.0, + input=(), + algorithm='AssimuloAlg', + options={}): + +A list of the different solver specific parameters can be found in the :doc:`usage` section. diff --git a/setup.py b/setup.py index 5b1b5d86..c77fdc8d 100644 --- a/setup.py +++ b/setup.py @@ -659,8 +659,8 @@ def fortran_extensionlists(self): AUTHOR_EMAIL = "christian.winther@modelon.com" VERSION = "3.7.0.dev0" if version_number_arg == "Default" else version_number_arg LICENSE = "LGPL" -URL = "http://www.jmodelica.org/assimulo" -DOWNLOAD_URL = "http://www.jmodelica.org/assimulo" +URL = "https://github.com/modelon-community/Assimulo" +DOWNLOAD_URL = "https://github.com/modelon-community/Assimulo/releases" DESCRIPTION = "A package for solving ordinary differential equations and differential algebraic equations." PLATFORMS = ["Linux", "Windows", "MacOS X"] CLASSIFIERS = [ 'Programming Language :: Python', @@ -685,9 +685,6 @@ def fortran_extensionlists(self): (http://www.unige.ch/~hairer/software.html) codes Radau5, Rodas and Dopri5 are also available. For the full list, see the documentation. -Documentation and installation instructions can be found at: -http://www.jmodelica.org/assimulo . - The package requires Numpy, Scipy and Matplotlib and additionally for compiling from source, Cython >=3, Sundials 2.6/2.7/3.1/4.1, BLAS and LAPACK together with a C-compiler and a FORTRAN-compiler.