search

yvs314 / epi-net-m

Data Processing and Simulation Tools for Networked SIR+
MIT License
1 stars 0 forks source link

Fixed crash due to unmatched tract IDs + minor fixes #17

Closed karaign closed 3 years ago

karaign commented 3 years ago

As for:

B.2 Please add instructions for running from system console, with sample usage.

I'm not sure if this means I should integrate the instructions into the CLI itself or put them into README.md. If it is the latter, does that mean removing the existing instructions, since they seem to be out of date?

yvs314 commented 3 years ago

Thanks! I will work through the fixes on the nearest Tue or Weds.

I'm not sure if this means I should integrate the instructions into the CLI itself or put them into README.md. If it is the latter, does that mean removing the existing instructions, since they seem to be out of date?

Good point, the principal README.md is of May '20 vintage, and it sure merits a usage section on Oboe. So I'd like you to do both:

  1. “inline”: put the briefest possible instruction as a comment into the oboe-cli.jl.
  2. README.md: Add a one-sentence description of the data processing routine right after the first header
  3. README.md: Add a “Usage: Data Processing” section before the outdated Usage section, and add the interface description there.
karaign commented 3 years ago

@yvs314 Thank you! I have fixed the minor issues, the incorrect dates in the changelog are just a result of careless copypasting.