Skip to content

Commit 64ff14a

Browse files
mrbuchemrbuche
authored
Merge pull request #180 from sandialabs/wlc
WLC isotensional
2 parents 3feb915 + fda75f2 commit 64ff14a

File tree

43 files changed

+10888
-85
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+10888
-85
lines changed

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "polymers"
3-
version = "0.3.4"
3+
version = "0.3.5"
44
edition = "2021"
55
description = "Polymers Modeling Library"
66
license = "BSD-3-Clause"

‎Project.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "Polymers"
22
uuid = "8aef037c-a721-4e8a-9d81-eb7093daef2c"
33
authors = ["mrbuche <[email protected]>"]
4-
version = "0.3.4"
4+
version = "0.3.5"
55

66
[deps]
77
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"

‎README.md‎

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,6 @@ The library can be installed as a Python package:
1717
pip install polymers
1818
```
1919

20-
If Rust is installed, the latest edition of the library can be installed from the GitHub repository:
21-
22-
```shell
23-
git clone [email protected]:sandialabs/Polymers.git
24-
cd Polymers/
25-
pip install maturin
26-
maturin build --features python
27-
pip install target/wheels/*.whl
28-
```
29-
3020
## Julia
3121

3222
[![docs (stable)](https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/julia-docs-stable.svg)](https://sandialabs.github.io/Polymers/julia/docs/stable)
@@ -40,30 +30,16 @@ using Pkg
4030
Pkg.add("Polymers")
4131
```
4232

43-
If Rust is installed, the latest edition of the library can be installed from the GitHub repository:
44-
45-
```julia
46-
using Pkg
47-
Pkg.add(url="https://github.com/sandialabs/Polymers")
48-
```
49-
5033
## Rust
5134

5235
[![docs (stable)](https://img.shields.io/badge/Docs-stable-e57300?logo=rust&logoColor=000000)](https://docs.rs/crate/polymers)
5336
[![docs (latest)](https://img.shields.io/badge/Docs-latest-e57300?logo=rust&logoColor=000000)](https://sandialabs.github.io/Polymers/rust/docs/latest)
5437
[![crates](https://img.shields.io/crates/v/polymers?logo=rust&logoColor=000000&label=Crates&color=32592f)](https://crates.io/crates/polymers)
5538

56-
The library can be used in an existing Rust project by adding the `polymers` crate to Cargo.toml:
39+
The library can be added to an existing Rust project:
5740

58-
```toml
59-
[dependencies]
60-
polymers = "*"
61-
```
62-
To use the latest edition of the library, add the GitHub repository to Cargo.toml:
63-
64-
```toml
65-
[dependencies]
66-
regex = { git = "https://github.com/sandialabs/polymers" }
41+
```shell
42+
cargo add polymers
6743
```
6844

6945
## Citation

‎docs/source/index.rst‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,6 @@ The library can be installed as a Python package:
1616
1717
pip install polymers
1818
19-
If Rust is installed, the latest edition of the library can be installed from the GitHub repository:
20-
21-
.. code-block:: sh
22-
23-
git clone [email protected]:sandialabs/Polymers.git
24-
cd Polymers/
25-
pip install maturin
26-
maturin build --features python
27-
pip install target/wheels/*.whl
28-
2919
Citation
3020
--------
3121

‎docs/source/physics/single_chain/wlc/thermodynamics.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ WLC model thermodynamics
55
:maxdepth: 1
66

77
Isometric <thermodynamics/isometric>
8+
Isometric <thermodynamics/isotensional>
89

910
.. autoclass:: polymers.physics.single_chain.wlc.thermodynamics::WLC(number_of_links, link_length, hinge_mass, persistance_length)
1011

@@ -13,3 +14,4 @@ WLC model thermodynamics
1314
.. autoattribute:: hinge_mass
1415
.. autoattribute:: persistance_length
1516
.. autoattribute:: isometric
17+
.. autoattribute:: isotensional

‎docs/source/physics/single_chain/wlc/thermodynamics/isotensional.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
WLC model thermodynamics (isotensional)
2+
=======================================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
Legendre <isotensional/legendre>
8+
9+
.. autoclass:: polymers.physics.single_chain.wlc.thermodynamics.isotensional::WLC(number_of_links, link_length, hinge_mass, persistance_length)
10+
11+
.. autoattribute:: number_of_links
12+
.. autoattribute:: link_length
13+
.. autoattribute:: hinge_mass
14+
.. autoattribute:: persistance_length
15+
.. autoattribute:: legendre
16+
.. automethod:: end_to_end_length(force, temperature)
17+
.. automethod:: end_to_end_length_per_link(force, temperature)
18+
.. automethod:: nondimensional_end_to_end_length(nondimensional_force)
19+
.. automethod:: nondimensional_end_to_end_length_per_link(nondimensional_force)
20+
.. automethod:: gibbs_free_energy(force, temperature)
21+
.. automethod:: gibbs_free_energy_per_link(force, temperature)
22+
.. automethod:: relative_gibbs_free_energy(force, temperature)
23+
.. automethod:: relative_gibbs_free_energy_per_link(force, temperature)
24+
.. automethod:: nondimensional_gibbs_free_energy(nondimensional_force, temperature)
25+
.. automethod:: nondimensional_gibbs_free_energy_per_link(nondimensional_force, temperature)
26+
.. automethod:: nondimensional_relative_gibbs_free_energy(nondimensional_force)
27+
.. automethod:: nondimensional_relative_gibbs_free_energy_per_link(nondimensional_force)
28+
29+
.. raw::
30+
html
31+
32+
<hr>
33+
34+
.. footbibliography::

‎docs/source/physics/single_chain/wlc/thermodynamics/isotensional/legendre.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
WLC model thermodynamics (isotensional/legendre)
2+
================================================
3+
4+
.. autoclass:: polymers.physics.single_chain.wlc.thermodynamics.isotensional.legendre::WLC(number_of_links, link_length, hinge_mass, persistance_length)
5+
6+
.. autoattribute:: number_of_links
7+
.. autoattribute:: link_length
8+
.. autoattribute:: hinge_mass
9+
.. autoattribute:: persistance_length
10+
.. automethod:: helmholtz_free_energy(force, temperature)
11+
.. automethod:: helmholtz_free_energy_per_link(force, temperature)
12+
.. automethod:: relative_helmholtz_free_energy(force, temperature)
13+
.. automethod:: relative_helmholtz_free_energy_per_link(force, temperature)
14+
.. automethod:: nondimensional_helmholtz_free_energy(nondimensional_force, temperature)
15+
.. automethod:: nondimensional_helmholtz_free_energy_per_link(nondimensional_force, temperature)
16+
.. automethod:: nondimensional_relative_helmholtz_free_energy(nondimensional_force)
17+
.. automethod:: nondimensional_relative_helmholtz_free_energy_per_link(nondimensional_force)

‎docs/src/index.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,6 @@ using Pkg
1616
Pkg.add("Polymers")
1717
```
1818

19-
If Rust is installed, the latest edition of the library can be installed from the GitHub repository:
20-
21-
```julia
22-
using Pkg
23-
Pkg.add(url="https://github.com/sandialabs/Polymers")
24-
```
25-
2619
## Citation
2720

2821
[![doi](https://img.shields.io/badge/Zenodo-10.5281%2Fzenodo.7041983-blue)](https://doi.org/10.5281/zenodo.7041983)

‎docs/src/physics/single_chain/wlc.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
* [WLC model thermodynamics](../../thermodynamics)
44

55
```@autodocs
6-
Modules = [Polymers.Physics.SingleChain.WLC]
6+
Modules = [Polymers.Physics.SingleChain.Wlc]
77
```

‎docs/src/physics/single_chain/wlc/thermodynamics.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# WLC model thermodynamics
22

33
* [WLC model thermodynamics (isometric)](../../../isometric)
4+
* [WLC model thermodynamics (isotensional)](../../../isotensional)
45

56
```@autodocs
6-
Modules = [Polymers.Physics.SingleChain.WLC.Thermodynamics]
7+
Modules = [Polymers.Physics.SingleChain.Wlc.Thermodynamics]
78
```

0 commit comments

Comments
 (0)