Skip to content

Commit

Permalink
Merge pull request #8 from GLVis/glvis-4.1-dev
Browse files Browse the repository at this point in the history
Website + Documentation updates for glvis-4.1
  • Loading branch information
tzanio authored Aug 31, 2021
2 parents f3d429c + 8c4101c commit e8a2aa3
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 25 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ If you've already cloned you can pull submodules with:
git submodule update --init --recursive
```

To make changes to the website pages:
To make changes to the website you will need an install of Python 3 with the following libraries:

- use MkDocs v1.0.4 with Markdown v2.6.8, PyYAML v3.13 and futures v3.3.0, e.g.
- use MkDocs v1.0.4 with Markdown v3.0 and the latest PyYAML
* `pip install --upgrade --user mkdocs==1.0.4`
* `pip install --upgrade --user Markdown==2.6.8`
* `pip install --upgrade --user PyYAML==3.13`
* `pip install --upgrade --user futures==3.3.0`
* `pip install --upgrade --user Markdown==3.0`
* `pip install --upgrade --user PyYAML`
- newer versions may not generate correct front page (to see the installed version, use `pip show mkdocs`)
- clone this repo,
- edit or add some ```.md``` files (you may also need to update the ```mkdocs.yml``` config),
- preview locally with ```mkdocs serve``` (Windows users may need to specify a port, such as ```mkdocs serve --dev-addr 127.0.0.1:4000```),
- publish with ```mkdocs gh-deploy```.
- edit or add some `.md` files (you may also need to update the `mkdocs.yml` config),
- preview locally with `mkdocs serve` (Windows users may need to specify a port, such as `mkdocs serve --dev-addr 127.0.0.1:4000`),
- publish with `mkdocs gh-deploy`.
15 changes: 5 additions & 10 deletions src/download.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## Latest Release

[New features](https://github.com/glvis/glvis/blob/v4.0/CHANGELOG)
[User documentation](https://github.com/glvis/glvis/blob/v4.0/README)
[New features](https://github.com/glvis/glvis/blob/v4.1/CHANGELOG)
[User documentation](https://github.com/glvis/glvis/blob/v4.1/README)
[Code documentation](http://glvis.github.io/doxygen/html/index.html)
[Sources](https://github.com/glvis/glvis)

[<button type="button" class="btn btn-success">
**Download glvis-4.0.tgz**
</button>](https://bit.ly/glvis-4-0)
**Download glvis-4.1.tgz**
</button>](https://bit.ly/glvis-4-1)
&nbsp;&nbsp;&nbsp;
[<button type="button" class="btn btn-primary">
**Use web version**
Expand All @@ -22,6 +22,7 @@ or [comments](https://github.com/glvis/glvis/issues/new?labels=comment).

**Filename** | **Version** | **Release Date** | **Size** | **[SLOC](https://github.com/AlDanial/cloc)** | **Notes** |
------------ | ----------- | ---------------- | -------- | --------------------------------------- | --------- |
[glvis-4.1.tgz](https://bit.ly/glvis-4-1) | v4.1 | Aug 2021 | 2.4M | 34K | |
[glvis-4.0.tgz](https://bit.ly/glvis-4-0) | v4.0 | Dec 2020 | 1.3M | 33K | _modern OpenGL, BSD license_ |
[glvis-3.4.tgz](https://bit.ly/glvis-3-4) | v3.4 | May 2018 | 199K | 27K | |
[glvis-3.3.tgz](https://goo.gl/C0Oadw) | v3.3 | Jan 2017 | 180K | 25K | |
Expand All @@ -32,9 +33,3 @@ or [comments](https://github.com/glvis/glvis/issues/new?labels=comment).
[glvis-v1.2.tgz](https://goo.gl/QLcnzW) | v1.2 | Apr 2011 | 150K | 19K |
[glvis-v1.1.tgz](https://goo.gl/n7wMF9) | v1.1 | Sep 2010 | 148K | 19K |
[glvis-v1.0.tgz](https://goo.gl/a5slBh) | v1.0 | Jul 2010 | 144K | 18K | _initial release_


[comment]: # ([glvis-d32411e0e4.tgz](https://goo.gl/XlXptO) | N/A | Jul 2014 | 171K | 22K | Development release)
[comment]: # ([glvis-d15634d151.tgz](https://goo.gl/YcpXYl) | N/A | Jul 2013 | 170K | 22K | Development release)

<!-- GLVis originates from the previous research effort in the (unreleased) [AggieFEM/aFEM](http://www.math.tamu.edu/research/vigre/archive/2000c-Lazarov.html) project. -->
9 changes: 9 additions & 0 deletions src/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@ When started without any options, GLVis [establishes a server](options-and-use.m

GLVis can also run a [batch sequence](options-and-use.md#glvis-scripts) of commands (GLVis scripts), which enable precise control of particular visualization scenes, and can be useful for making animations.

## Native and Web Versions

<img class="floatpad" src="../img/glvis_app.png" width="130">
GLVis runs natively on Mac, Linux, and Windows. It can also run a browser, using
the [web version](https://glvis.org/live), or a Jupyter notebook, using
[pyglvis](https://github.com/glvis/pyglvis) or [xeus-glvis](https://github.com/glvis/xeus-glvis).
On Mac, GLVis can be built as a native app bundle that can be added to the Dock, double-clicked in the Finder,
etc.

## Open Source

GLVis is an open-source software, and can be freely used under the terms of the [BSD](https://github.com/glvis/glvis/blob/master/LICENSE) license.
Binary file added src/img/glvis_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,21 +63,21 @@ GLVis is based on the [MFEM](https://mfem.org) library and is used in the [BLAST

Date | Message
------------ | -----------------------------------------------------------------
Aug 31, 2021 | Version 4.1 [released](https://github.com/glvis/glvis/blob/v4.1/CHANGELOG).
Jul 10, 2021 | [MFEM Community Workshop](workshop.md) in October.
Feb 19, 2021 | Web version at [glvis.org/live](https://glvis.org/live).
Feb 17, 2021 | Jupyter support: [`pip install glvis`](https://github.com/GLVis/pyglvis).
Dec 11, 2020 | Version 4.0 [released](https://github.com/glvis/glvis/blob/v4.0/CHANGELOG).
Dec 11, 2020 | Switched to a BSD license.

## Latest Release

[New features](https://github.com/glvis/glvis/blob/v4.0/CHANGELOG)
[User documentation](https://github.com/glvis/glvis/blob/v4.0/README)
[New features](https://github.com/glvis/glvis/blob/v4.1/CHANGELOG)
[User documentation](https://github.com/glvis/glvis/blob/v4.1/README)
[Code documentation](http://glvis.github.io/doxygen/html/index.html)
[Sources](https://github.com/glvis/glvis)

[<button type="button" class="btn btn-success">
**Download glvis-4.0.tgz**
</button>](https://bit.ly/glvis-4-0)
**Download glvis-4.1.tgz**
</button>](https://bit.ly/glvis-4-1)
&nbsp;&nbsp;&nbsp;
[<button type="button" class="btn btn-primary">
**Use web version**
Expand All @@ -95,7 +95,7 @@ Dec 11, 2020 | Switched to a BSD license.

New users should start with the [options and general use](options-and-use.md) tutorial.

We also recommend reading the [MFEM project](http://mfem.org) documentation.
We also recommend reading the [MFEM project](https://mfem.org) documentation.

## Contact

Expand Down
2 changes: 2 additions & 0 deletions src/news.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

&nbsp; | |
------------ | -----------------------------------------------------------------
Aug 31, 2021 | Version 4.1 [released](https://github.com/glvis/glvis/blob/v4.1/CHANGELOG).
Jul 10, 2021 | The inaugural [MFEM Community Workshop](workshop.md) will take place on October 20th, 2021.
Feb 19, 2021 | Web version at [glvis.org/live](https://glvis.org/live).
Feb 17, 2021 | Jupyter support: [`pip install glvis`](https://github.com/GLVis/pyglvis).
Dec 11, 2020 | Version 4.0 [released](https://github.com/glvis/glvis/blob/v4.0/CHANGELOG).
Expand Down

0 comments on commit e8a2aa3

Please sign in to comment.