Skip to content

Commit

Permalink
Adds dependency and link to readthedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
johnwslee committed Feb 22, 2022
1 parent 85ece54 commit 4a55e6a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,22 @@ <h2>Usage</h2>
<p><code>extrucal</code> can be used to calculate throughput in extrusion processes and to generate table and plot for throughput as a function of screw RPM and channel depth in the metering section of screw</p>
<pre class="python"><code>from extrucal.extrucal import throughput, throughput_table, throughput_plot</code></pre>
</div>
<div id="dependencies" class="section level2">
<h2>Dependencies</h2>
<ul>
<li><p>Python 3.9 and Python packages:</p>
<ul>
<li>pandas==1.4.1</li>
<li>numpy==1.22.2</li>
<li>ipykernel==6.9.1</li>
<li>altair-saver==0.5.0</li>
</ul></li>
</ul>
</div>
<div id="documentation" class="section level2">
<h2>Documentation</h2>
<p>Documentation <code>extrucal</code> can be found at <a href="https://extrucal.readthedocs.io/en/latest/">Read the Docs</a></p>
</div>
<div id="contributing" class="section level2">
<h2>Contributing</h2>
<p>Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.</p>
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ $ pip install extrucal
from extrucal.extrucal import throughput, throughput_table, throughput_plot
```

## Dependencies

- Python 3.9 and Python packages:

- pandas==1.4.1
- numpy==1.22.2
- ipykernel==6.9.1
- altair-saver==0.5.0

## Documentation

Documentation `extrucal` can be found at [Read the Docs](https://extrucal.readthedocs.io/en/latest/)

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
Expand Down

0 comments on commit 4a55e6a

Please sign in to comment.