Skip to content

Commit 1b28ee3

Browse files
committed
Updated user manual formatting
1 parent 59a4b7f commit 1b28ee3

File tree

1 file changed

+33
-24
lines changed

1 file changed

+33
-24
lines changed

doc/MARGE_user_manual/MARGE_user_manual.tex

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ \section{Team Members}
5353

5454
\begin{itemize}
5555
\item \href{https://github.com/mdhimes/}{Michael D. Himes},
56-
Morgan State University/NASA Goddard Space Flight Center ([email protected])
56+
Morgan State University/NASA GSFC ([email protected])
5757
\item Joseph Harrington, University of Central Florida
5858
\item Adam Cobb, University of Oxford
5959
\item David C. Wright, University of Central Florida
@@ -104,8 +104,8 @@ \section{Introduction}
104104
.3 quick\_example.
105105
.2 lib.
106106
.3 datagen.
107-
.3 loss.
108107
.4 BART.
108+
.3 loss.
109109
.2 modules.
110110
.3 BART.
111111
}
@@ -451,7 +451,7 @@ \subsection{MARGE Configuration File}
451451

452452
\noindent The available options for a MARGE configuration file are listed below.
453453

454-
\noindent \underline(General Parameters)
454+
\noindent \underline{General Parameters}
455455
\begin{itemize}
456456
\item verb : int. Determines how much output is logged.
457457
0: Only errors/critical information.
@@ -462,7 +462,7 @@ \subsection{MARGE Configuration File}
462462
5: Maximum detail.
463463
\end{itemize}
464464

465-
\noindent \underline(Directories)
465+
\noindent \underline{Directories}
466466
\begin{itemize}
467467
\item inputdir : str. Directory containing MARGE inputs.
468468
\item outputdir : str. Directory containing MARGE outputs.
@@ -650,7 +650,7 @@ \subsubsection{Layers}
650650
\href{https://keras.io/api/layers/}{the relevant Keras documentation}.
651651

652652
\begin{center}
653-
\begin{tabular}{| l | l | l | l | l |}
653+
\begin{tabular}{| l | p{3cm} | l | l | p{2cm} |}
654654
\hline
655655
Layer & MARGE configuration file option & Has nodes? & Layer parameter & Default layer parameter \\
656656
\hline\hline
@@ -964,7 +964,8 @@ \subsection{General information}
964964
were computed on the log-transformed data. If both scaling and normalization
965965
are applied, MARGE will first apply normalization and then apply scaling; users
966966
must normalize the minima and maxima to achieve the proper transformation
967-
in their code. \newline
967+
in their code. Note that this is equivalent to simply scaling, so it is
968+
recommended that users do not use both normalization and scaling. \newline
968969

969970
\noindent Users will also need to post-process the predictions in the same way
970971
that MARGE does. This follows the opposite order as the pre-processing: first
@@ -1015,9 +1016,9 @@ \subsection{Other languages}
10151016
described in Section \ref{sec:generalusemodel}. \newline
10161017

10171018
\noindent If a user finds a useful library for a language of their choice, please
1018-
consider informing the author so it can be mentioned here. Below are two
1019-
such libraries that the author is aware of, but there are surely other, possibly
1020-
more feature-rich, libraries out there. \newline
1019+
consider informing the author or submitting a pull request so it can be
1020+
mentioned here. Below are two such libraries that the author is aware of,
1021+
but there are surely other, possibly more feature-rich, libraries out there. \newline
10211022

10221023
\noindent For C-based codes, users can consider the
10231024
\href{https://github.com/alrevuelta/cONNXr}{cONNXr library}. Note that there
@@ -1129,21 +1130,29 @@ \section{Be Kind}
11291130
\href{https://iopscience.iop.org/article/10.3847/PSJ/abe3fd/meta}{Himes et al. 2022, PSJ, 3, 91}
11301131

11311132
\begin{verbatim}
1132-
@ARTICLE{2022PSJ.....3...91H,
1133-
author = {{Himes}, Michael D. and {Harrington}, Joseph and {Cobb}, Adam D. and {G{\"u}ne{\c{s}} Baydin}, At{\i}l{\i}m and {Soboczenski}, Frank and {O'Beirne}, Molly D. and {Zorzan}, Simone and {Wright}, David C. and {Scheffer}, Zacchaeus and {Domagal-Goldman}, Shawn D. and {Arney}, Giada N.},
1134-
title = "{Accurate Machine-learning Atmospheric Retrieval via a Neural-network Surrogate Model for Radiative Transfer}",
1135-
journal = {\psj},
1136-
keywords = {Exoplanet atmospheres, Bayesian statistics, Posterior distribution, Convolutional neural networks, Neural networks, 487, 1900, 1926, 1938, 1933},
1137-
year = 2022,
1138-
month = apr,
1139-
volume = {3},
1140-
number = {4},
1141-
eid = {91},
1142-
pages = {91},
1143-
doi = {10.3847/PSJ/abe3fd},
1144-
adsurl = {https://ui.adsabs.harvard.edu/abs/2022PSJ.....3...91H},
1145-
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
1146-
}
1133+
@ARTICLE{2022PSJ.....3...91H,
1134+
author = {{Himes}, Michael D. and {Harrington}, Joseph and
1135+
{Cobb}, Adam D. and {G{\"u}ne{\c{s}} Baydin}, At{\i}l{\i}m and
1136+
{Soboczenski}, Frank and {O'Beirne}, Molly D. and
1137+
{Zorzan}, Simone and {Wright}, David C. and
1138+
{Scheffer}, Zacchaeus and {Domagal-Goldman}, Shawn D. and
1139+
{Arney}, Giada N.},
1140+
title = "{Accurate Machine-learning Atmospheric Retrieval via a Neural-network
1141+
Surrogate Model for Radiative Transfer}",
1142+
journal = {\psj},
1143+
keywords = {Exoplanet atmospheres, Bayesian statistics, Posterior distribution,
1144+
Convolutional neural networks, Neural networks,
1145+
487, 1900, 1926, 1938, 1933},
1146+
year = 2022,
1147+
month = apr,
1148+
volume = {3},
1149+
number = {4},
1150+
eid = {91},
1151+
pages = {91},
1152+
doi = {10.3847/PSJ/abe3fd},
1153+
adsurl = {https://ui.adsabs.harvard.edu/abs/2022PSJ.....3...91H},
1154+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
1155+
}
11471156
\end{verbatim}
11481157

11491158
\noindent Thanks!

0 commit comments

Comments
 (0)