mirror of
https://github.com/JuliaFEM/JuliaFEM.jl.git
synced 2026-08-06 04:21:33 +00:00
docs
This commit is contained in:
+16
-8
@@ -2,6 +2,9 @@
|
||||
JuliaFEM
|
||||
========
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/JuliaFEM/JuliaFEM.jl/master/docs/logo/JuliaFEMLogo_256x256.png
|
||||
:target: https://github.com/JuliaFEM/JuliaFEM.jl
|
||||
|
||||
The JuliaFEM project develops open-source software for reliable, scalable, distributed Finite Element Method.
|
||||
|
||||
.. image:: https://badges.gitter.im/Join%20Chat.svg
|
||||
@@ -16,6 +19,8 @@ The JuliaFEM project develops open-source software for reliable, scalable, distr
|
||||
|
||||
Documentation: http://www.juliaFEM.org
|
||||
|
||||
GitHub respository: https://github.com/JuliaFEM/JuliaFEM.jl
|
||||
|
||||
|
||||
The JuliaFEM software library is a framework that allows for the distributed processing of large Finite Element Models across clusters of computers using simple programming models. It is designed to scale up from single servers to thousands of machines, each offering local computation and storage. The basic design principle is: everything is nonlinear. All physics models are nonlinear from which the linearization are made as a special cases.
|
||||
|
||||
@@ -41,15 +46,18 @@ We strongly believe in the test driven development as well as building on top of
|
||||
|
||||
`The Zen of Python <https://www.python.org/dev/peps/pep-0020/>`_
|
||||
|
||||
| Beautiful is better than ugly.
|
||||
| Explicit is better than implicit.
|
||||
| Simple is better than complex.
|
||||
| Complex is better than complicated.
|
||||
| Flat is better than nested.
|
||||
| Sparse is better than dense.
|
||||
| Readability counts.
|
||||
| Errors should never pass silently.
|
||||
| Beautiful is better than ugly.
|
||||
| Explicit is better than implicit.
|
||||
| Simple is better than complex.
|
||||
| Complex is better than complicated.
|
||||
| Flat is better than nested.
|
||||
| Sparse is better than dense.
|
||||
| Readability counts.
|
||||
| Errors should never pass silently.
|
||||
|
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
Interested in participating? Please start by reading `CONTRIBUTING.md <https://github.com/JuliaFEM/JuliaFEM/blob/master/CONTRIBUTING.md>`_.
|
||||
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||

|
||||
# JuliaFEM
|
||||
|
||||
[](https://gitter.im/JuliaFEM/JuliaFEM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
Build Status: [](https://travis-ci.org/JuliaFEM/JuliaFEM.jl)
|
||||
|
||||
Code Coverage: [](https://coveralls.io/r/JuliaFEM/JuliaFEM.jl?branch=master)
|
||||
|
||||
Documentation: [](https://readthedocs.org/projects/juliafem/?badge=latest)
|
||||
|
||||
The JuliaFEM project develops open-source software for reliable, scalable, distributed Finite Element Method.
|
||||
|
||||
The JuliaFEM software library is a framework that allows for the distributed processing of large Finite Element Models across clusters of computers using simple programming models. It is designed to scale up from single servers to thousands of machines, each offering local computation and storage. The basic design principle is: everything is nonlinear. All physics models are nonlinear from which the linearization are made as a special cases.
|
||||
|
||||
JuliaFEM current status: project planning
|
||||
|
||||
Initial road map for JuliaFEM:
|
||||
|
||||
version | number of degree of freedom | number of cores
|
||||
----------|-----------------------------------------|----------------------
|
||||
1.0 | 100 000 000 | 1 000
|
||||
2.0 | 1 000 000 000 | 10 000
|
||||
3.0 | 10 000 000 000 | 100 000
|
||||
|
||||
We strongly believe in the test driven development as well as building on top of previous work. Thus all the new code in this project should be 100% tested. Also other people have wisdom in style as well:
|
||||
|
||||
[The Zen of Python](https://www.python.org/dev/peps/pep-0020/)
|
||||
```
|
||||
Beautiful is better than ugly.
|
||||
Explicit is better than implicit.
|
||||
Simple is better than complex.
|
||||
Complex is better than complicated.
|
||||
Flat is better than nested.
|
||||
Sparse is better than dense.
|
||||
Readability counts.
|
||||
Errors should never pass silently.
|
||||
```
|
||||
|
||||
Interested in participating? Please start by reading [CONTRIBUTING.md](https://github.com/JuliaFEM/JuliaFEM/blob/master/CONTRIBUTING.md).
|
||||
|
||||
Contributors: see [contributors](https://github.com/JuliaFEM/JuliaFEM/blob/master/contributors)
|
||||
|
Before Width: | Height: | Size: 735 B After Width: | Height: | Size: 735 B |
|
Before Width: | Height: | Size: 736 B After Width: | Height: | Size: 736 B |
|
Before Width: | Height: | Size: 739 B After Width: | Height: | Size: 739 B |
+4
-2
@@ -19,8 +19,10 @@ import shlex
|
||||
import sphinx_rtd_theme
|
||||
import datetime
|
||||
|
||||
with open("last_updated.rst", "w") as fh:
|
||||
fh.write("Documentation last updated (UTC): {0}".format(str(datetime.datetime.utcnow())))
|
||||
#with open("last_updated.rst", "w") as fh:
|
||||
# fh.write("Documentation last updated (UTC): {0}".format(str(datetime.datetime.utcnow())))
|
||||
|
||||
html_last_updated_fmt = "%Y-%m-%d %H:%M:%S"
|
||||
|
||||
extensions = ['juliadoc.julia', 'juliadoc.jlhelp']
|
||||
html_theme_path = [juliadoc.get_theme_dir(), sphinx_rtd_theme.get_html_theme_path()]
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
.. include:: last_updated.rst
|
||||
.. include:: ../README.rst
|
||||
|
||||
.. toctree::
|
||||
|
||||
@@ -3,7 +3,7 @@ Tutorials
|
||||
|
||||
Tutorials are automatically generated each time new commit is done.
|
||||
|
||||
.. |pass| image:: ../assets/build-passing-brightgreen.svg
|
||||
.. |pass| image:: /_static/build-passing-brightgreen.svg
|
||||
|
||||
.. include:: notebooks.rst
|
||||
|
||||
|
||||
Reference in New Issue
Block a user