Prepare Initial Release

README.md

@@ -1,6 +1,42 @@
-![](images/logo.svg)
-
-Loading animation sequences with meshio and fileseq
+![](images/logo_as_path.svg)
+
+This is an addon for Blender 3.1+ (might work with 2.8+ but has not been tested) that enables loading of file sequences. The addon comes bundled together with [meshio](https://github.com/nschloe/meshio) which enables the loading of geometric data from a multitude of file formats. As stated there, the supported formats are listed in the following. Note that not all of the formats have been tested and some issues may still occur.
+
+> [Abaqus](http://abaqus.software.polimi.it/v6.14/index.html) (`.inp`),
+> ANSYS msh (`.msh`),
+> [AVS-UCD](https://lanl.github.io/LaGriT/pages/docs/read_avs.html) (`.avs`),
+> [CGNS](https://cgns.github.io/) (`.cgns`),
+> [DOLFIN XML](https://manpages.ubuntu.com/manpages/jammy/en/man1/dolfin-convert.1.html) (`.xml`),
+> [Exodus](https://nschloe.github.io/meshio/exodus.pdf) (`.e`, `.exo`),
+> [FLAC3D](https://www.itascacg.com/software/flac3d) (`.f3grid`),
+> [H5M](https://www.mcs.anl.gov/~fathom/moab-docs/h5mmain.html) (`.h5m`),
+> [Kratos/MDPA](https://github.com/KratosMultiphysics/Kratos/wiki/Input-data) (`.mdpa`),
+> [Medit](https://people.sc.fsu.edu/~jburkardt/data/medit/medit.html) (`.mesh`, `.meshb`),
+> [MED/Salome](https://docs.salome-platform.org/latest/dev/MEDCoupling/developer/med-file.html) (`.med`),
+> [Nastran](https://help.autodesk.com/view/NSTRN/2019/ENU/?guid=GUID-42B54ACB-FBE3-47CA-B8FE-475E7AD91A00) (bulk data, `.bdf`, `.fem`, `.nas`),
+> [Netgen](https://github.com/ngsolve/netgen) (`.vol`, `.vol.gz`),
+> [Neuroglancer precomputed format](https://github.com/google/neuroglancer/tree/master/src/neuroglancer/datasource/precomputed#mesh-representation-of-segmented-object-surfaces),
+> [Gmsh](https://gmsh.info/doc/texinfo/gmsh.html#File-formats) (format versions 2.2, 4.0, and 4.1, `.msh`),
+> [OBJ](https://en.wikipedia.org/wiki/Wavefront_.obj_file) (`.obj`),
+> [OFF](https://segeval.cs.princeton.edu/public/off_format.html) (`.off`),
+> [PERMAS](https://www.intes.de) (`.post`, `.post.gz`, `.dato`, `.dato.gz`),
+> [PLY](<https://en.wikipedia.org/wiki/PLY_(file_format)>) (`.ply`),
+> [STL](<https://en.wikipedia.org/wiki/STL_(file_format)>) (`.stl`),
+> [Tecplot .dat](http://paulbourke.net/dataformats/tp/),
+> [TetGen .node/.ele](https://wias-berlin.de/software/tetgen/fformats.html),
+> [SVG](https://www.w3.org/TR/SVG/) (2D output only) (`.svg`),
+> [SU2](https://su2code.github.io/docs_v7/Mesh-File/) (`.su2`),
+> [UGRID](https://www.simcenter.msstate.edu/software/documentation/ug_io/3d_grid_file_type_ugrid.html) (`.ugrid`),
+> [VTK](https://vtk.org/wp-content/uploads/2015/04/file-formats.pdf) (`.vtk`),
+> [VTU](https://vtk.org/Wiki/VTK_XML_Formats) (`.vtu`),
+> [WKT](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) ([TIN](https://en.wikipedia.org/wiki/Triangulated_irregular_network)) (`.wkt`),
+> [XDMF](https://xdmf.org/index.php/XDMF_Model_and_Format) (`.xdmf`, `.xmf`).
+
+[fileseq](https://github.com/justinfx/fileseq) is used to identify and load file sequences, while [rich](https://github.com/Textualize/rich) and [python-future](https://github.com/PythonCharmers/python-future) are included to satisfy unmet dependencies of the other packages.
+
+All data is loaded *just-in-time* when the Blender frame changes, in order to avoid excessive memory consumption. By default, the addon is able to load vertices, lines, triangles and quads. It is also able to automatically extract triangle and quad surface meshes from tetrahedral and hexahedral volume meshes. Scalar and vector attributes on vertices are also imported for visualization purposes. See the following documentation for a brief introduction.
+
+**DISCLAIMER: This project is still very much under development, so breaking changes may occur at any time!**
 
 - [1. Installation](#1-installation)
   - [1.1 Build from source (optional)](#11-build-from-source-optional)
@@ -17,6 +53,7 @@ Loading animation sequences with meshio and fileseq
     - [2.3.2 Path Information](#232-path-information)
     - [2.3.3 Attributes Settings](#233-attributes-settings)
     - [2.3.4 Split Norm per Vertex](#234-split-norm-per-vertex)
+    - [2.3.5 Advanced Settings](#235-advanced-settings)
 
 ## 1. Installation
 
@@ -133,3 +170,7 @@ We also provide the ability to use a per-vertex vector attribute as custom norma
 For more details check the official documentation [here](https://docs.blender.org/manual/en/latest/modeling/meshes/structure.html#modeling-meshes-normals-custom).
 
 Note: the addon does not check if the selected attribute is suitable for normals or not. E.g. if the data type of the attribute is int instead of float, then Blender will simply give a runtime error.
+
+#### 2.3.5 Advanced Settings
+
+TODO

__init__.py

@@ -2,7 +2,7 @@
     "name": "Sequence Loader",
     "description": "Loader for meshio supported mesh files/ simulation sequences",
     "author": "Interactive Computer Graphics",
-    "version": (1, 0),
+    "version": (0, 1, 0),
     "blender": (3, 1, 0),
     "warning": "",
     "support": "COMMUNITY",