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.

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

Restructure API Documentation #331

Closed
wants to merge 8 commits into from
Closed

Conversation

chraibi
Copy link
Collaborator

@chraibi chraibi commented Apr 4, 2024

Address the discussion #318.

@Ozaq Ozaq changed the title Add new structure to API Restructure API Documentation Apr 4, 2024
@Ozaq
Copy link
Collaborator

Ozaq commented Apr 4, 2024

I took the liberty to rename the PR to better reflect whats happening here :)

@Ozaq Ozaq added the documentation Improvements or additions to documentation label Apr 4, 2024
@schroedtert
Copy link
Collaborator

From discussion:

  • Analysis methods
    • Fundamental measures
      • density
      • speed
      • flow
      • acceleration
    • further methods
      • spatial methods
      • motion profiles
      • temporal

@chraibi chraibi requested a review from schroedtert May 28, 2024 15:29
@chraibi
Copy link
Collaborator Author

chraibi commented May 29, 2024

Wait for #320 and #336.

chraibi and others added 6 commits June 4, 2024 12:21
Correct documentation of option for line_width in plot_walkable_area
* udate-version-file

* First implementation pdf computation

* First debuged version

* 2d and optimisation

* Add notebook to test pdf function

* Add documentation and vectorised version of dist calculation

* fix stack of arrays and use Divide

* Raise warning for division by null values during pdf computation PedestrianDynamics#330

* Add a parameter to pdf to control the number of data scrambling loops PedestrianDynamics#326

* Method error fix

* Change atribute name and documentation

* First modification of the User guide

* Final Changes User guide and remove test codes

* Minor correction User guide

* del _version for the PR

* Clear  User Guide output

* Bug fix

* Changing name of the file containning the pdf computation

* Minor correction and formating to pass all continuity tests

* Editing the text of PDF

* fix small typos

* Changing name in the API doc

---------

Co-authored-by: Mohcine Chraibi <m.chraibi@fz-juelich.de>
@chraibi chraibi closed this Jun 11, 2024
@chraibi chraibi deleted the API branch June 11, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants