Skip to content

Commit

Permalink
Updated to v1.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bshoshany committed Sep 17, 2021
1 parent 6a39002 commit 21d5400
Show file tree
Hide file tree
Showing 8 changed files with 6,592 additions and 1,526 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03416/status.svg)](https://doi.org/10.21105/joss.03416)
[![arXiv:2109.04193](https://img.shields.io/badge/arXiv-2109.04193-b31b1b.svg)](https://arxiv.org/abs/2109.04193)
[![License: MIT](https://img.shields.io/github/license/bshoshany/thread-pool)](https://github.com/bshoshany/OGRe/blob/master/LICENSE.txt)
![Language: Mathematica 12](https://img.shields.io/badge/Language-Mathematica%2012-yellow)
![File size in bytes](https://img.shields.io/github/size/bshoshany/OGRe/OGRe.m)
Expand All @@ -16,6 +17,7 @@ Department of Physics, Brock University,\
DOI: [10.21105/joss.03416](https://doi.org/10.21105/joss.03416)

* [Version history](#version-history)
* [v1.7.0 (2021-09-17)](#v170-2021-09-17)
* [v1.6.1 (2021-09-01)](#v161-2021-09-01)
* [v1.6 (2021-08-07)](#v16-2021-08-07)
* [v1.5 (2021-06-07)](#v15-2021-06-07)
Expand All @@ -27,6 +29,26 @@ DOI: [10.21105/joss.03416](https://doi.org/10.21105/joss.03416)

## Version history

### v1.7.0 (2021-09-17)

* New modules:
* `TCalcGeodesicWithTimeParameter[]` calculates the geodesic equations with respect to the time parameter (which is assumed to be the first coordinate) instead of an affine curve parameter.
* `TCalcNormSquared[]` calculates the norm-squared of a tensor with respect to its metric, that is, the tensor contracted with itself in all indices. For example, for a vector v<sup>&mu;</sup> the norm-squared will be v<sup>&mu;</sup>v<sub>&mu;</sub> and for a rank-2 tensor T<sup>&mu;&nu;</sup> the result will be T<sup>&mu;&nu;</sup> T<sub>&mu;&nu;</sub>.
* `TCite[]` displays information on how to cite this package in published research. Thank you for citing my work! :)
* Changes to existing modules:
* `TCalc*` modules no longer display a progress bar for the calculation. The progress bar wasn't too useful, since almost all tensor calculations are very fast even on an average laptop. Simplifications are the only operations which take any considerable amount of time, and thus progress bars are now displayed only for simplifications.
* `TCovariantD` and `TPartialD`:
* If `TCovariantD` is used on a scalar, it is now replaced automatically with `TPartialD` to improve performance, since the covariant derivative of a scalar is just a partial derivative anyway.
* Fixed bug where acting on scalars incorrectly returned a list of lists instead of a vector.
* `TGetComponents` now applies a function given in the last argument to the components, and then simplifies them (in parallel, if parallelization is enabled), before returning the components. Note that `TShow` and `TList` have already had this option for some time, but now `TGetComponents` has it too.
* `TLineElement` now simplifies the line element before returning it.
* `TSimplify` now allows the user to simplify any expression, not just tensor objects. `TSimplify[expression]` simplifies `expression` based on the user-defined simplification assumptions set using `TSetAssumptions`. If `expression` is a `List`, the components will be simplified in parallel. The user can thus make use of OGRe's optimized simplification process to simplify any Mathematica expression.
* Other changes:
* Fixed a bug where simplification assumptions were not applied correctly if parallelization was enabled.
* Added arXiv badge to `README.md` and `CHANGELOG.md`.
* Added a `CITATION.cff` file (in YAML format) to the GitHub repository. This should add [an option to get a citation in different formats](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files) directly from GitHub repository by clicking on "cite this repository" on the sidebar to the right.
* Added a `CITATION.bib` file (in BibTeX format) to the GitHub repository. You can use it to easily cite this package in your papers.

### v1.6.1 (2021-09-01)

* This package is now [published in the Journal of Open Source Software](https://joss.theoj.org/papers/10.21105/joss.03416)! I added links to the paper and updated the citation information. The old Zenodo citation should not be used anymore.
Expand Down
12 changes: 12 additions & 0 deletions CITATION.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
@article{Shoshany2021_OGRe,
author = {Barak Shoshany},
doi = {10.21105/joss.03416},
journal = {Journal of Open Source Software},
number = {65},
pages = {3416},
publisher = {The Open Journal},
title = {OGRe: An Object-Oriented General Relativity Package for Mathematica},
url = {https://doi.org/10.21105/joss.03416},
volume = {6},
year = {2021}
}
26 changes: 26 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
authors:
- family-names: "Shoshany"
given-names: "Barak"
orcid: "https://orcid.org/0000-0003-2222-127X"
cff-version: "1.2.0"
date-released: "2021-09-01"
doi: "10.21105/joss.03416"
license: "MIT"
message: "If you use this package in published research, please cite it as follows."
repository-code: "https://github.com/bshoshany/OGRe"
title: "OGRe: An Object-Oriented General Relativity Package for Mathematica"
preferred-citation:
type: "article"
authors:
- family-names: "Shoshany"
given-names: "Barak"
orcid: "https://orcid.org/0000-0003-2222-127X"
doi: "10.21105/joss.03416"
issue: 65
journal: "Journal of Open Source Software"
month: 9
start: 3416
title: "OGRe: An Object-Oriented General Relativity Package for Mathematica"
volume: 6
year: 2021
42 changes: 21 additions & 21 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
MIT License

Copyright (c) 2021 Barak Shoshany

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
MIT License
Copyright (c) 2021 Barak Shoshany
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 21d5400

Please sign in to comment.