summaryrefslogtreecommitdiffstats
path: root/libraries/libgdsii/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/libgdsii/README')
-rw-r--r--libraries/libgdsii/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/libraries/libgdsii/README b/libraries/libgdsii/README
new file mode 100644
index 0000000000..51955f7ac9
--- /dev/null
+++ b/libraries/libgdsii/README
@@ -0,0 +1,13 @@
+libGDSII is a C++ library for working with GDSII binary data files,
+intended primarily for use with the computational electromagnetism
+codes scuff-em and meep but sufficiently general-purpose to allow
+other uses as well.
+
+The packages consists of
+
+a C++ library (libGDSII) with API functions for reading, processing,
+and exporting GDSII files
+
+a command-line executable code (GDSIIConvert) for reporting statistics
+on GDSII geometries and exporting them to other file formats, notably
+including the GMSH geometry format.