iastro-pt / codereviewclub

The main repository for IA's Code Review Club

iastro-pt

codereviewclub's Issues

Styler Documentation

Some more documentation and example use cases for styler would be helpful.

I will note here some things that I have had to learn the hard way which could go into documentation.

• Figure width is fixed to 1 or 2 columns in A&A publication.
• To change the figure height pass figsize=(None, height_multiplier) where height_multiplier is a multiple of the figure width (default is 0.75).
• removing save shows the plot instead

Other things to include:

• Example latex commands to import a single or full sized image generated by styler.

\begin{figure}
    \includegraphics[width=\hsize]{styler_one.pdf}  % chktex 8
    \caption{}
    \label{}
\end{figure}

\begin{figure*}
    \includegraphics[width=\hsize]{styler_two.pdf}  % chktex 8
    \caption{}
    \label{}
\end{figure*}

Organize scripts in folder

I think it would be a good idea to include the the scripts for review in a folder:

    - README.md
    - invitation.md
    - slides.odp
    - slides.pdf
    - CR1
        - styler.py
        - README.md
    - CR2
        - astronomy.py
        - README.md

The README.md files are optional, but it would be nice with a very short documentation (what does this file do, how do I use it?)