Skip to content

Commit

Permalink
Add a note on using potprox as an ES module
Browse files Browse the repository at this point in the history
  • Loading branch information
Amphiluke committed Jul 16, 2018
1 parent 7521176 commit b5fb9d4
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# potprox

Approximation of computed data with empirical pair potentials.

## Synopsis

It is a quite common case when there is a need to describe computed numerical *ab initio* data with some analytical form of pair potential (e.g. the [Lennard-Jones function](https://en.wikipedia.org/wiki/Lennard-Jones_potential) or the [Morse function](https://en.wikipedia.org/wiki/Morse_potential)).
Expand All @@ -16,7 +18,7 @@ Potprox uses the [method of least squares](https://en.wikipedia.org/wiki/Least_s

Use the module in [environments with ES6 support](https://kangax.github.io/compat-table/es6/).

## Install
## Install and load potprox

**As a NodeJS module:**

Expand All @@ -32,6 +34,12 @@ The version for browsers (and web workers) is also available: check out the [dis
<script src="dist/potprox.min.js"></script>
```

If you use ES modules, you may import the potprox module from the [potprox.min.mjs](dist/potprox.min.mjs) file.

```javascript
import potprox from "./dist/potprox.min.mjs";
```

**Web workers:**

```javascript
Expand Down

0 comments on commit b5fb9d4

Please sign in to comment.