Skip to content

Documentation and howto for High school students and undergrad students #19

@Fonotec

Description

@Fonotec

The last improvements of the code have increasingly made the code more user friendly. So this is extremely nice. This means that the code is user friendly for the average programmer in end undergrad or masters. To increase the user base of the code we should make documentation and a howto file for these two groups with additional explanation of what a pulsar is.

For high school students this should contain (Dutch, in the future we could also consider English or German for Stockert):

  • How to get Python on Windows, something like Spyder
  • How to run the code using Spyder
  • Short explanation what Python is.
  • Explanation of the parameter file
  • Explanation what is a pulsar
  • Explain the physics of the signal
  • Examples and possible research questions

For undergrads this should contain (English):

  • How to download the code using git
  • How to run the code
  • Indepth explanation what is a pulsar
  • Physics of the signal and explanation what the different modules in the code do.
  • Explanation of the parameter file

If any of you know more things which should be added let me know! Is this something @Moyoxkit can help with?

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions