Project review by Katrin Ros

[katrinros]

Hi Saeid,

Nice project, with a clear and clean outline and nicely outlined purpose. I like that it is clearly divided into separated steps (intro, post-processing, output). Please see below for the detailed comments according to the project requirements.

Best,
Katrin ([email protected])

Documentation:

• title and abstract of the project (max 300 words)
  Includes a title and an abstract.
• includes instructions on how to run the notebook
  Instructions on how to run the notebook are included.
• includes the required packages in an environment.yml file
  I could not find an environment.yml file included in the project.
• includes a brief explanation of the reason each package/library was used
  There is no explanations for the use of packages/libraries in the project. This could for example be added either in the documentation, or just as comments in the code.
• includes rich documentation using Markdown (equations, tables, links, images or videos)
  The project includes rich documentation with Markdown with nice images. However, the table the pictures are in seems to have an issue, with the table formatting showing up when the pictures are displayed.
• is reproducible, i.e., someone else should be able to redo the steps
  The project is reproducible, with images and data being included in the project.

Input/Output:

• uses pandas to read large data sets or numpy to load data from text files
  Pandas are used to read in files
• uses pandas to save to disk the processed or generated data
  The generated plots are saved, but not the processed data

Scientific computing/data processing:

• performs numerical operations (numpy, scipy, pandas) or manipulates, groups, and aggregates a data set (pandas)
  Numerical operations are performed.

Data visualization:

• includes at least one composite plot (inset or multiple panels)
  The project includes a plot with multiple panels.

produces publication ready quality figures (see here for an editorial guide on Graphical Excellence):

• the figures are 89 mm wide (single column) or 183 mm wide (double column)
  The figure size is 15,8 inches, so does not correspond to the specified size.
• the axes are labeled
  Axes have labels (including units where applicable).
• the font sizes are sufficiently large
  Yes, font sizes are large and readable.
• the figures are saved as rasterized images (300 dpi) or vector art
  The figures are saved as pdf files with 100 dpi, so should be changed according to the specifications. There is a problem with saving the figures, instead of saving the individual figures the whole plot grid is saved, with only the first plot in the first saved figure, the two first in the second etc.

Version control, sharing, and archiving:

• is archived in a repository with a digital object identifier (DOI)
  I don’t think the project is archived with a DOI yet.

[saeidpiraniGitHub]

Hi Karin

Thanks for your comments, I implement all your comments except figure size because 89mm and 183 mm are small for my pictures.