Skip to content

Commit

Permalink
- added an introduction pharagraph to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amkrajewski committed Jan 17, 2024
1 parent 7e198a3 commit 83f523e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions nimplex.nim
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import nimpy

## **NIM** sim**PLEX**: A concise scientific Nim library (with CLI and Python binding) providing samplings, uniform grids, and traversal graphs in compositional (simplex) spaces.
##
## Such spaces are considered when an entity can be split into a set of distinct components (a composition), and they play a critical role in many disciplines of science, engineering, and mathematics. For instance, in materials science, chemical composition refers to the way a material (or, more generally, matter) is split into distinct components, such as chemical elements, based on considerations such as fraction of atoms, occupied volume, or contributed mass. And in economics, portfolio composition may refer to how finite capital is split across assets, such as cash, equity instruments, real estate, and commodities, based on their monetary value.
##
## ## Installation
## There are several **easy** ways to quickly get *nimplex* up and running on your system. The choice depends primarily on your preffered way of interacting with the library (CLI, Nim, or Python) and your system configuration.
##
Expand Down

0 comments on commit 83f523e

Please sign in to comment.