Skip to content

Commit

Permalink
Improved README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SanPen committed Nov 19, 2024
1 parent ac81701 commit 2de0aea
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 73 deletions.
102 changes: 47 additions & 55 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ All of these are industry tested algoriths, some of which surpass most comemerci
The aim is to be a drop-in replacement for the expensive and less usable commercial
software, so that you can work, research and learn with it.

### Resources
## Resources

In an effort to ease the simulation and construction of grids,
We have included extra materials to work with. These are included in the standalone setups.
Expand All @@ -139,7 +139,7 @@ We have included extra materials to work with. These are included in the standal
- [Equipment catalogue](https://gridcal.readthedocs.io/en/latest/data_sheets.html) (Wires, Cables and Transformers)
ready to use in GridCal.

### Tutorials and examples
## Tutorials and examples

- [Tutorials](https://gridcal.readthedocs.io/en/latest/rst_source/tutorials/tutorials_module.html)

Expand All @@ -151,6 +151,25 @@ We have included extra materials to work with. These are included in the standal

- [The tests](https://github.com/SanPen/GridCal/tree/master/src/tests) may serve as a valuable source of examples.


## Matpower grids

Matpower's excellent formulations and consistency has allowed this and other
projects to develop, relying on its sound math. That is why GridCal reads Matpower
cases out of the box, without you having to do anything special.
And of course, GridCal solves all Matpower 8 provided grids, solving the continental USA case in about 1 second:


[![GridCal](Grids_and_profiles/matpower_benchmark/n_buses_vs_time.png)](https://www.youtube.com/watch?v=O-tb_um8YtU)

Find the results: [All matpower grids.xlsx](Grids_and_profiles/matpower_benchmark/All%20matpower%20grids.xlsx),
and the benchmark code [matpower_grids.py](Grids_and_profiles/matpower_benchmark/matpower_grids.py).
_Results simulated with AMD 9750x and 64 GB of RAM under Ubuntu 24.04.
All solved using Newton-Raphson, and only using the provided solution
that comes with the files when the flat start fails.

Cool right?

## API

Since day one, GridCal was meant to be used as a library as much as it was meant
Expand Down Expand Up @@ -194,6 +213,8 @@ which are fast. This steps benefits greatly the efficiency of the numerical calc
aligned in memory. The GridCal data model is object-oriented, while the numerical circuit is array-oriented
(despite beign packed into objects)



### Loading a grid

```python
Expand Down Expand Up @@ -1138,23 +1159,7 @@ reply_from_server = asyncio.get_event_loop().run_until_complete(
print(reply_from_server)
```

## Matpower grids

Matpower's excellent formulations and consistency has allowed this and other
projects to develop, relying on its sound math. That is why GridCal reads Matpower
cases out of the box, without you having to do anything special.
And of course, GridCal solves all Matpower 8 provided grids, solving the continental USA case in about 1 second:


[![GridCal](Grids_and_profiles/matpower_benchmark/n_buses_vs_time.png)](https://www.youtube.com/watch?v=O-tb_um8YtU)

Find the results: [All matpower grids.xlsx](Grids_and_profiles/matpower_benchmark/All%20matpower%20grids.xlsx),
and the benchmark code [matpower_grids.py](Grids_and_profiles/matpower_benchmark/matpower_grids.py).
_Results simulated with AMD 9750x and 64 GB of RAM under Ubuntu 24.04.
All solved using Newton-Raphson, and only using the provided solution
that comes with the files when the flat start fails.

Cool right?

## Tests

Expand Down

0 comments on commit 2de0aea

Please sign in to comment.