Ian Jauslin
summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README53
1 files changed, 53 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b637888
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+This directory contains the source files to typeset the article, and generate
+the figures. This can be accomplished by running
+ make
+
+This document uses a custom class file, located in the 'libs' directory, which
+defines a number of commands. Most of these are drop-in replacements for those
+defined in the 'article' class.
+
+Some extra functionality is provided in custom style files, located in the
+'libs' directory.
+
+
+* Dependencies:
+
+ pdflatex
+ TeXlive packages:
+ amsfonts
+ color
+ graphics
+ hyperref
+ latex
+ marginnote
+ pgf
+ standalone
+ GNU make
+ python3
+ gnuplot
+
+* Files:
+
+ Jauslin-IASletter_2017.tex:
+ main LaTeX file
+
+ libs:
+ custom LaTeX class and style files
+
+ figs:
+ source code for the figures
+
+ figs/pyrite.jpg:
+ photo by: JJ Harrison
+ https://commons.wikimedia.org/wiki/File:Pyrite_from_Ampliación_a_Victoria_Mine,_Navajún,_La_Rioja,_Spain_2.jpg
+ licensed under Creative Commons BY-SA 3.0
+ https://creativecommons.org/licenses/by-sa/3.0/
+
+ figs/dimer_example.fig/dimer_conf.py:
+ this python script randomly generates a suitable dimer configuration for
+ the figures interaction.pdf boundary.pdf bounding_loop.pdf and
+ dimer_contour.pdf
+
+ figs/atoms.fig/*.py:
+ these python script randomly generate nematic, chiral nematic and liquid
+ configurations, as well as a deterministic crystalline configuration.