Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typo corrections and eliminations #84

Merged
merged 3 commits into from
Jun 10, 2024
Merged

typo corrections and eliminations #84

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e76af3
typo corrections and eliminations
kzqureshi Nov 30, 2023
ce38af3
Add links to ubermagutil typesystem documentation
lang-m May 9, 2024
75fecf0
Merge branch 'master' into typo_corrections
samjrholt Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/constants.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
4 changes: 2 additions & 2 deletions docs/deriving-dynamics-term.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The dynamics object is created. The last thing we have to impose on the energy class is the typesystem. More precisely, we have to make sure no negative $\\xi$ values are allowed, $\\mathbf{v}$ is three-dimensional and that `name` attribute accepts only valid Python variable names. This is done by using `ubermagutil`. Full documentation can be found [here](https://ubermagutil.readthedocs.io/en/latest/)."
"The dynamics object is created. The last thing we have to impose on the energy class is the typesystem. More precisely, we have to make sure no negative $\\xi$ values are allowed, $\\mathbf{v}$ is three-dimensional and that `name` attribute accepts only valid Python variable names. This is done by using `ubermagutil`."
lang-m marked this conversation as resolved.
Show resolved Hide resolved
]
},
{
Expand Down Expand Up @@ -337,7 +337,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
4 changes: 2 additions & 2 deletions docs/deriving-energy-term.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The energy object is created. The last thing we have to impose on the energy class is the typesystem. More precisely, we have to make sure no negative $U$ values are allowed and that `name` attribute accepts only valid Python variable names. This is done by using `ubermagutil`. Full documentation can be found [here](https://ubermagutil.readthedocs.io/en/latest/)."
"The energy object is created. The last thing we have to impose on the energy class is the typesystem. More precisely, we have to make sure no negative $U$ values are allowed and that `name` attribute accepts only valid Python variable names. This is done by using `ubermagutil`."
lang-m marked this conversation as resolved.
Show resolved Hide resolved
]
},
{
Expand Down Expand Up @@ -273,7 +273,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
4 changes: 2 additions & 2 deletions docs/dynamics-terms.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"For time-dependent current terms please refer to [this notebook](https://ubermag.github.io/documentation/ipynb/oommfc/timedependent-field-current.html)."
"For time-dependent current terms please refer to [this notebook](https://ubermag.github.io/examples/notebooks/time-dependent-field-current.html)."
]
},
{
Expand Down Expand Up @@ -650,7 +650,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
6 changes: 3 additions & 3 deletions docs/energy-terms.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@
"- Arbitratry time dependence specified as a function\n",
"- Custom `tcl` code for `OOMMF`\n",
"\n",
"In this notebook, only the predefined functions are shown. For the other options please refer to [this notebook](https://ubermag.github.io/documentation/ipynb/oommfc/timedependent-field-current.html).\n",
"In this notebook, only the predefined functions are shown. For the other options please refer to [this notebook](https://ubermag.github.io/examples/notebooks/time-dependent-field-current.html).\n",
"\n",
"Either sine or sinc wave can be used to multiply `H`. For instance, in order to define a time-dependent external field, which is a sine wave with $1 \\,\\text{GHz}$ frequency and $t_{0} = 2\\,\\text{ps}$ shift."
]
Expand Down Expand Up @@ -1218,7 +1218,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"This Hamiltonian consists of two energy term. To add another term to it `+=` operator can be used."
"This Hamiltonian consists of two energy terms. To add another term to it `+=` operator can be used."
]
},
{
Expand Down Expand Up @@ -1423,7 +1423,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
2 changes: 1 addition & 1 deletion docs/evolver-driver.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
2 changes: 1 addition & 1 deletion docs/same-class-terms.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion docs/system.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
4 changes: 2 additions & 2 deletions docs/term-parameters.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
"tags": []
},
"source": [
"The values of these two (scalar and vector) fields can be then set using Python functions. For further details, plese refer to `discretisedfield` [documentation](https://discretisedfield.readthedocs.io/en/latest/)."
"The values of these two (scalar and vector) fields can be then set using Python functions."
]
}
],
Expand All @@ -120,7 +120,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.8.17"
},
"widgets": {
"application/vnd.jupyter.widget-state+json": {
Expand Down
Loading