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

[docs] Update more detailed and clearer documentation #22

Merged
merged 14 commits into from
Jun 20, 2024
Merged

[docs] Update more detailed and clearer documentation #22

merged 14 commits into from
Jun 20, 2024

Conversation

Routhleck
Copy link
Collaborator

@Routhleck Routhleck commented Jun 17, 2024 •
edited
Loading

Physical Units

  • index
  • Quantity
    • Creating Quantity Instances
    • Converting to Different Units
    • Attributes of a Quantity
    • Arithmetic Functions
      • Addition and Subtraction
      • Multiplication and Division
      • Power
    • Built-in Functions
    • Indexing, Slicing and Iterating
  • Standard Units
    • Prefix
  • Constants
  • Mechanisms of Quantity / Dimension / Unit
  • Quantity Conversion for Other Utilities
    • Dimensionless Quantities
    • Plotting Quantities
    • Converting to Plain Python Scalars
  • Combining, Defining, and Displaying Units
    • Basic example
    • Defining units
    • Displaying in JIT / grad / ... transformations

Mathematical Functions

  • index
  • NumPy Functions
    • Shape Manipulation
      • Changing the shape of a Quantity
      • Stacking together different Quantities
      • Splitting one Quantity into several smaller ones
    • Comparing Quantities
  • Customize Functions that Accept Quantities

@Routhleck Routhleck marked this pull request as ready for review June 18, 2024 14:47
chaoming0625
chaoming0625 approved these changes Jun 20, 2024
View reviewed changes
Copy link
Collaborator

@chaoming0625 chaoming0625 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great work.

@chaoming0625 chaoming0625 merged commit 894a420 into main Jun 20, 2024
24 checks passed
@chaoming0625 chaoming0625 deleted the docs branch June 20, 2024 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chaoming0625 chaoming0625 chaoming0625 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Routhleck @chaoming0625