Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check and complete documentation #62

Closed
8 tasks done
CFGrote opened this issue Apr 28, 2022 · 5 comments
Closed
8 tasks done

Check and complete documentation #62

CFGrote opened this issue Apr 28, 2022 · 5 comments
Assignees
@JunCEEE @shervin86 @godot11 @mads-bertelsen
Labels
documentation Improvements or additions to documentation Must have High priority

Comments

@CFGrote
Copy link
Contributor

CFGrote commented Apr 28, 2022 •
edited by JunCEEE
Loading

We need the following in the libpyvinyl documentation

  • Introduction: Describe the general idea of libpyvinyl, its intended usage. Discuss how the software addresses FAIRness of simulations and simulation data.
  • Components: Describe the major classes: Calculator, CalculatorParameters, Parameter, Instrument, Data (I may have forgotten one or two).
  • Component relations: Make a graph visualization to explain how the various components are connected
  • Installation: How to install the software
  • Testing: How to run the unit test suite
  • Example: How to use libpyvinyl
  • Real world examples: Link to code snippets or notebooks where libpyvinyl is used in McStasScript, simex, or ???
  • Accessibility: Ensure that the correct version of documentation is linked from the repository (It is currently on the old v0.0.1).
@CFGrote CFGrote added documentation Improvements or additions to documentation Must have High priority labels Apr 28, 2022
@JunCEEE
Copy link
Contributor

JunCEEE commented Apr 29, 2022 •
edited
Loading

I had a discussion with Mads about the documentation. The conclusion of the discussion is basically in line with what's described here. I posted the content of #48 here as a reference.

Overall thoughts:
Users for libpyvinyl are not stupid. Can be precise and short. Use links to the reference when possible.
Subsections are coming to reference manual. Will be easier to link to!

Getting started

  • Overview [1 page of text, what is the problem and how does libpyvinyl solve it]
  • Installation [0.5 page, pip / source and tests]
  • Libpyvinyl projects [0.25 page + links to libpyvinyl packages documentation]
  • Quick start [plus minus example (short), links to projects that use libpyvinyl]

User guide [Perhaps to be done later]

  • BaseCalculator [1 page, purpose / intent]
  • Parameters [1 page, purpose / intent]
  • BaseData [1 page, purpose / intent]
  • BaseFormat [1 page, purpose / intent]
  • Instrument [1 page, purpose / intent]

Developer guide lines

  • How to make a libpyvinyl based package [1 page, basic structure diagram, expanding the base-classes]
  • Plus Minus example [longer version]

@JunCEEE JunCEEE moved this from Todo to In Progress in Milestone MS5.3: VINYL software release Apr 29, 2022
JunCEEE added a commit to JunCEEE/libpyvinyl that referenced this issue May 4, 2022
@JunCEEE
Refine the words according to PaNOSC-ViNYL#62
5d14bdc
@JunCEEE
Copy link
Contributor

JunCEEE commented May 5, 2022

It's being addressed here: #49

@JunCEEE
Copy link
Contributor

JunCEEE commented May 5, 2022 •
edited
Loading

  • Mads: Quick start introduction Mads
  • Jun: Quickstart using Plusminus as an example.
  • Shervin: Instrument user guide

@CFGrote
Copy link
Contributor Author

CFGrote commented May 16, 2022

can this be closed?

@JunCEEE
Copy link
Contributor

JunCEEE commented May 17, 2022

Yes

@JunCEEE JunCEEE closed this as completed May 17, 2022
Repository owner moved this from In Progress to Done in Milestone MS5.3: VINYL software release May 17, 2022
JunCEEE added a commit that referenced this issue May 17, 2022
@JunCEEE
Refine the words according to #62
74f4b88
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JunCEEE JunCEEE

@shervin86 shervin86

@godot11 godot11

@mads-bertelsen mads-bertelsen

Labels
documentation Improvements or additions to documentation Must have High priority
Projects
No open projects
Milestone MS5.3: VINYL software release
Status: Done
Milestone
No milestone
Development

No branches or pull requests
5 participants
@JunCEEE @shervin86 @godot11 @CFGrote @mads-bertelsen