Skip to content

Commit

Permalink
Joss Responses: Library Documentation and Basic Profiling (#64)
Browse files Browse the repository at this point in the history
* README documentation enhancement
* Addition of Github pages
* Removal of unicode characters from the JOSS md, and inclusion of local build instructions
---------

Co-authored-by: Panadestein <[email protected]>
  • Loading branch information
AlexBuccheri and Panadestein authored Jul 26, 2023
1 parent a02b3c0 commit d00b256
Show file tree
Hide file tree
Showing 10 changed files with 1,438 additions and 315 deletions.
10 changes: 9 additions & 1 deletion GX-TimeFrequency/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# GreenX Library - TimeFrequency

This library provides optimal quadrature grid points and weights for imaginary time-frequency transforms, commonly
occurring in MP2, RPA and Green's function methods. Optimisation is performed with the Minimax procedure, minimising the
maximum error of the quadrature. This typically results in an error that is more evenly distributed across the interval
of interest. Grids are provided with n-points ranging from 6 to 34, and for different values of the transition energy
ratios Rm (on average 15 R-values for each grid point).

For additional details, please refer to the corresponding JOSS paper, included [here](../JOSS).

## Building

With CMake, change to the GreenX root, then type:
Expand All @@ -14,7 +22,7 @@ make install
## Running the Tests

Application tests are run with the pytest framework. Having installed `pygreenx`
(see the top-level README) change to `<GX_ROOT>/<BUILD_DIR>` and type `ctest`.
(see the top-level [README](../README.md)) change to `<GX_ROOT>/<BUILD_DIR>` and type `ctest`.
Additionally, one can change to the test folder and explicitly run the pytest
command from there:

Expand Down
11 changes: 10 additions & 1 deletion JOSS/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
# JOSS
# Compiling the JOSS Paper

To build the paper with [pandoc](https://pandoc.org/installing.html) (3.0.1):

```shell
pandoc --citeproc --bibliography=refs.bib -s paper.md -o gx_minimax.pdf --template latex.template
```

with a latex templated sourced from a Github [source]( https://github.com/Wandmalfarbe/pandoc-latex-template/blob/master/eisvogel.tex)
rather than the [JOSS template](https://github.com/sigsep/open-unmix-paper-joss/blob/master/latex.template).
Loading

0 comments on commit d00b256

Please sign in to comment.