Merge branch '215-add-release-notes' into 'developer'

Resolve "Add release notes"

See merge request AM/AMfe!216

CONTRIBUTING.md

@@ -37,7 +37,7 @@ Checklist:
 which can be found in setup.py
 - [ ] Add your name with a comment what you have fixed in the THANKS.txt (This is voluntary,
 but really desired to give every author credit)
-- [ ] Add a release-note in the release-notes.txt (in docs/release)
+- [ ] Add a release-note in the X.Y.Z-notes.txt (in docs/release where X.X.X stands for the next released version)
 - [ ] If it is a new major function, perhaps add a tutorial/example etc. in the main documentation
 - [ ] Check that the code you use is BSD license compatible! If it is your own code, note that
 you accept the BSD license conditions
@@ -75,7 +75,7 @@ any tests that show the performance of the code
 - Does the code meet the checklist above?
 - Is there any code that is duplicated at another part? In this case, can it be refactored?
 - Are the new functions/features tested properly by a unittest?
-- Are there docstrings for the new fuctions/features?
+- Are there docstrings for the new functions/features?
 
 
 Testing

docs/contents.rst

@@ -9,6 +9,7 @@ Table of Contents
    chapters/fundamentals/index
    chapters/examples/index
    Package <chapters/package_doc/index>
+   release/index
    notes
 
 ******************

docs/index.rst

@@ -12,6 +12,10 @@ AMfe Documentation
 
 AMfe is built in order to provide a simple and lean, yet powerful finite element framework for research purpose.
 
+Release notes
+-------------
+
+API changes and new features can be found in the :doc:`Release Notes<release/index>`
 
 **********************************
 How the documentation is organized

docs/release/1.0.0-notes.rst

@@ -0,0 +1,145 @@
+========================
+AMfe 1.0.0 Release Notes
+========================
+
+
+Highlights of this release
+--------------------------
+
+The Amfe package originally developed by Johannes Rutzmoser
+has been refactored to a fully new structure.
+Amfe now consists of many decoupled subpackages.
+The code has been refactored in such a way that many classes are much more decoupled
+from each other and thus more flexible.
+
+Furthermore, this refactoring led to a structure that is much easier to extend or subclass.
+For instance, several mapping algorithms could be possible by just writing a subclass of the Mapping class.
+
+
+New features
+============
+
+amfe.assembly improvements
+--------------------------
+
+- The assembly now expects a numpy array to write to it such that it does not preallocate new memory
+- The assembly for constraints is straight-forward
+
+amfe.component improvements
+---------------------------
+
+- A basic class called component is provided that is used as a facade for the other finite element classes.
+- Components can be connected to a tree to provide a datastructure for substructuring and parallel computing
+
+
+amfe.constraint improvements
+----------------------------
+
+- Nonlinear constraints are now possible
+
+amfe.element improvements
+-------------------------
+
+- Minor improvements
+
+amfe.fortran improvements
+-------------------------
+
+-
+
+amfe.io improvements
+--------------------
+
+- The I/O of Meshes and Postprocessing Data is fully decoupled from the rest of the code
+- A Reader Writer system with the builder pattern has been established to decouple read and write mechanisms
+- GiD Json format is now readable
+
+amfe.linalg improvements
+------------------------
+
+-
+
+amfe.mapping improvements
+-------------------------
+
+- The mapping now supports subclassing to have other mappings than AMfe provides by default
+
+
+amfe.mor improvements
+---------------------
+
+- The Model reduction functions are fully decoupled from the other classes such that also other systems than AMfe Finite Element models could be reduced
+- The Polynomial Expansion now is a basic feature
+
+amfe.neumann improvements
+-------------------------
+
+- The Neumann Conditions now have a Neumann manager that makes the bookkeeping of several Neumann conditions
+
+amfe.parametric improvements
+----------------------------
+
+- First mesh morphing techniques are implemented to change the mesh geometry parametrically
+- FFD morphing
+- RBF morphing
+
+amfe.solver improvements
+------------------------
+
+- The solvers have been decoupled from other classes
+- The time integration is subdivided in several classes that are responsible for different steps
+- Seperate class for running the integration at all until the specified end time
+- Seperate class to provide initial condition for the acceleration
+- Seperate class to handle the residuals and the Jacobians for different time integration schemes
+- A solver factory has been created to easily configure a complex solver object
+
+amfe.forces improvements
+------------------------
+
+- Basic force distributions are provided by the forces module
+
+amfe.material improvements
+--------------------------
+
+-
+
+amfe.mesh improvements
+----------------------
+
+- The mesh now supports Groups and Tags
+- The mesh is decoupled from other classes
+
+amfe.structural_dynamics improvements
+-------------------------------------
+
+- Decoupling from other classes has been achieved
+
+amfe.tools improvements
+-----------------------
+
+-
+
+amfe.ui improvements
+--------------------
+
+- A User Interface has been added for users that do not go too deep into AMfe's class structure
+
+
+Deprecated features
+===================
+
+- Only second order systems are supported by now
+- Direct Assembly for reduced systems was removed
+- Quadratic Manifold features was removed
+- Time step adaption was removed
+
+Backwards incompatible changes
+==============================
+
+- Nearly all due to large API changes
+
+
+Other changes
+=============
+
+- Many tests have been written to enhance code coverage from 40 % to about 77 % coverage

docs/release/1.1.0-notes.rst

@@ -0,0 +1,78 @@
+========================
+AMfe 1.1.0 Release Notes
+========================
+
+
+Highlights of this release
+--------------------------
+
+
+New features
+============
+
+amfe.assembly improvements
+--------------------------
+
+amfe.constraint improvements
+----------------------------
+
+amfe.element improvements
+-------------------------
+
+amfe.fortran improvements
+-------------------------
+
+amfe.io improvements
+--------------------
+
+amfe.linalg improvements
+------------------------
+
+amfe.mapping improvements
+-------------------------
+
+amfe.mor improvements
+---------------------
+
+amfe.neumann improvements
+-------------------------
+
+amfe.parametric improvements
+----------------------------
+
+amfe.solver improvements
+------------------------
+
+- Prediction step in Generalized Alpha scheme changed
+
+amfe.forces improvements
+------------------------
+
+amfe.material improvements
+--------------------------
+
+amfe.mesh improvements
+----------------------
+
+amfe.structural_dynamics improvements
+-------------------------------------
+
+amfe.tools improvements
+-----------------------
+
+amfe.ui improvements
+--------------------
+
+
+Deprecated features
+===================
+
+Backwards incompatible changes
+==============================
+
+Other changes
+=============
+
+- Release notes have been added
+- Setup.py was divided in conda setup und setup develop
+- Setup.py general improvements

docs/release/X.X.X-notes.rst

@@ -0,0 +1,73 @@
+========================
+AMfe X.X.X Release Notes
+========================
+
+
+Highlights of this release
+--------------------------
+
+
+New features
+============
+
+amfe.assembly improvements
+--------------------------
+
+amfe.constraint improvements
+----------------------------
+
+amfe.element improvements
+-------------------------
+
+amfe.fortran improvements
+-------------------------
+
+amfe.io improvements
+--------------------
+
+amfe.linalg improvements
+------------------------
+
+amfe.mapping improvements
+-------------------------
+
+amfe.mor improvements
+---------------------
+
+amfe.neumann improvements
+-------------------------
+
+amfe.parametric improvements
+----------------------------
+
+amfe.solver improvements
+------------------------
+
+amfe.forces improvements
+------------------------
+
+amfe.material improvements
+--------------------------
+
+amfe.mesh improvements
+----------------------
+
+amfe.structural_dynamics improvements
+-------------------------------------
+
+amfe.tools improvements
+-----------------------
+
+amfe.ui improvements
+--------------------
+
+
+Deprecated features
+===================
+
+Backwards incompatible changes
+==============================
+
+Other changes
+=============
+

docs/release/index.rst

@@ -0,0 +1,10 @@
+*************
+Release Notes
+*************
+
+
+.. toctree::
+  :maxdepth: 1
+
+  1.1.0-notes
+  1.0.0-notes