Skip to content

Commit

Permalink
Separated todo. Spellcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
dvd101x authored Mar 26, 2024
1 parent 0b1e610 commit 999d304
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 17 deletions.
25 changes: 8 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,9 @@ This is an example of how to run CoolProp Javascript wrapper with units handled
[![interface](interface.png)](https://dvd101x.github.io/web-thermodynamics/
)

# To-Do
- [x] Migrate to codemirror 6 with a build tool like Vite
- [ ] Migrate the language definition to CM6
- [x] Scroll outputs into view and highlight them
- [x] Not only text outputs (allow for latex)
- [ ] More efficient math evaluation (only update state when inputs change)
- [ ] Evaluate expression by expression (not necessarly block by block)
- [x] Use Alpinejs to reduce code
- [ ] Dynamic autocomplete

# Getting started

Clone this repository and run the following command to install dependancies.
Clone this repository and run the following command to install dependencies.
```
npm install
```
Expand Down Expand Up @@ -47,7 +37,7 @@ It loads with three example expressions for each of the CoolProp functions avail
50423.450391029 J / kg
```
On this example we mix the putouts with **markdown** and equations with **latex** if we start the comment with a `# ` this is a nice way to make present the results including some input markdown.
On this example we mix the outputs with **markdown** and equations with **latex** if we start the comment with a `# ` this is a nice way to make present the results including some input markdown.
# Getting started
Expand All @@ -71,7 +61,7 @@ flowchart LR

# Intermediate example

This demo uses libraries with many capabilities. There are many conversions available for inputs and ouputs and the results can be stored on variables, arrays and objects to be used later.
This demo uses libraries with many capabilities. There are many conversions available for inputs and outputs and the results can be stored on variables, arrays and objects to be used later.

``` python
# Density of carbon dioxide at 100 bar and 25C in lbm/in^3
Expand All @@ -90,7 +80,7 @@ cycle = [{},{}];
# Temperature of saturated air at the previous enthalpy
cycle[1].T = HAprops('T', {P:1 atm, H:enthalpyDry, R:1.0})

# Temperature of saturated air in farenheit
# Temperature of saturated air in Fahrenheit
cycle[2].T = HAprops('T', {H:enthalpyDry, R:1.0, P:1 atm}) to degF

```
Expand Down Expand Up @@ -160,7 +150,7 @@ twophase
-7.7679894680327e-5 (J kg) / (kg K J)
```

These concepts can be used to calculate complete thermodyinamic cycles.
These concepts can be used to calculate complete thermodynamic cycles.

``` python
# # Vapor compression cycle
Expand Down Expand Up @@ -271,10 +261,10 @@ Here is a similar project [Engineering-Solver](https://github.com/dvd101x/Engine

* Saves in the browser (you can continue where you left off)
* 20 workspaces, so you can try different things
* Uses a webworker to avoid freezing during big calculaitons
* Uses a webworker to avoid freezing during big calculations
* A few more examples focused on the many features of mathjs

# Dependancies
# Dependencies

Uses the following js libraries

Expand All @@ -287,6 +277,7 @@ Uses the following js libraries
* [Markdown-it](https://github.com/markdown-it/markdown-it)
* [markdown-it-katex](https://github.com/waylonflinn/markdown-it-katex)
* [katex](https://katex.org/)
* [alpinejs](https://alpinejs.dev/)

# References

Expand Down
16 changes: 16 additions & 0 deletions todo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# To-Do
- [x] Scroll outputs into view and highlight them
- [ ] Migrate the language definition to CM6
- [ ] Dynamic autocomplete
- [ ] More efficient math evaluation (only update state when inputs change)
- [ ] Evaluate expression by expression (not necessarly block by block)

# Maybe
- [ ] Saves state
- [ ] Webworkers

# Done [x]
- [x] Migrate to codemirror 6 with a build tool like Vite
- [x] Not only text outputs (allow for latex)
- [x] Use Alpinejs to reduce code

0 comments on commit 999d304

Please sign in to comment.