Skip to content

Commit 1d6c06b

Browse files
eirikurjeirikurj
authored
Merge pull request #1 from camader/pySpline
updated build documentation
2 parents 30f2340 + 38d8af7 commit 1d6c06b

File tree

10 files changed

+895
-42
lines changed

10 files changed

+895
-42
lines changed

‎doc/building.rst

Lines changed: 17 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -8,58 +8,33 @@ library for doing the time consuming computational operators. It is
88
therefore necessary to build this library before using
99
:ref:`pySpline`.
1010

11-
To see a list of architectures that :ref:`pySpline` has been known to
12-
compile on run::
13-
14-
make
11+
pySpline follows the standard MDO Lab build procedure.
12+
To start, find a configuration file close to your current setup in::
1513

16-
from the root directory.
14+
$ config/defaults
1715

18-
The easiest approach to to try the cloest one to your system and
19-
attempt a build using (for example)::
16+
and copy it to ''config/config.mk''. For example::
2017

21-
make LINUX_INTEL
18+
$ cp config/defaults/config.LINUX_GFORTRAN.mk config/config.mk
19+
20+
If you are a beginner user installing the packages on a linux desktop,
21+
you should use the ``config.LINUX_GFORTRAN.mk`` versions of the configuration
22+
files. The ``config.LINUX_INTEL.mk`` versions are usually used on clusters.
23+
24+
Once you have copied the config file, compile :ref:`pySpline` by running::
25+
26+
$ make
2227

2328
If everything was successful, the following lines will be printed to
2429
the screen (near the end)::
2530

2631
Testing if module pyspline can be imported...
27-
Module libspline was successfully imported.
32+
Module pyspline was successfully imported.
2833

2934
If you don't see this, it will be necessary to configure the build
30-
manually. To configure manually, first copy a default configuration
31-
file from the defaults folder like this (run this in the root
32-
direcotry)::
33-
34-
cp config/defaults/config.LINUX_INTEL.mk config
35-
36-
Now open ``config/config.LINUX_INTEL.mk`` which should look like::
37-
38-
# Config File for LINUX and INTEL Compiler
39-
AR = ar
40-
AR_FLAGS = -rvs
41-
RM = /bin/rm -rf
42-
43-
# Fortran compiler and flags
44-
FF90 = ifort
45-
FF90_FLAGS = -r8 -O2 -fPIC
46-
47-
# C compiler and flags
48-
CC = gcc
49-
CC_FLAGS = -O2 -fPIC
50-
51-
# Define potentially different python, python-config and f2py executables:
52-
PYTHON = python
53-
PYTHON-CONFIG = python-config
54-
F2PY = f2py
55-
56-
# Define additional flags for linking
57-
LINKER_FLAGS = -nofor_main -lifport
58-
SO_LINKER_FLAGS =-fPIC -shared
59-
60-
Modify these parameters are required and attempt the build again. If
61-
you have sucessfully compiled the code on a new system, please contact
62-
the developpers such that a new default configuration file can be
35+
manually. To configure manually, open ``config/config.mk`` and modify options as necessary.
36+
If you have successfully compiled the code on a new system, please contact
37+
the developers such that a new default configuration file can be
6338
added.
6439

6540

‎doc/themes/mdolab_theme/globaltoc.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<h3>Table of Contents</h3>
2+
{{ toctree(maxdepth=-1, titles_only=true) }}
3+

‎doc/themes/mdolab_theme/layout.html

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
{% extends "basic/layout.html" %}
2+
3+
{# Collapsible sidebar script from default/layout.html in Sphinx #}
4+
{% set script_files = script_files + ['_static/sidebar.js'] %}
5+
6+
{# Add the google webfonts needed for the logo #}
7+
{% block extrahead %}
8+
<link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600' rel='stylesheet' type='text/css'>
9+
{% endblock %}
10+
11+
12+
{% block header %}
13+
<div class="topbar">
14+
<a class="brand" title="{{ _('Documentation Home') }}" href="{{ pathto(master_doc) }}"><span id="logotext1">{{ theme_logotext1 }}</span><span id="logotext2">{{ theme_logotext2 }}</span><span id="logotext3">{{ theme_logotext3 }}</span></a>
15+
<ul>
16+
<li><a class="homelink" title="MDOLAB Homepage" href="http://mdolab.engin.umich.edu"></a></li>
17+
<li><a title="{{ _('General Index') }}" href="{{ pathto('genindex') }}">Index</a></li>
18+
<li><a title="{{ _('Module Index') }}" href="{{ pathto('py-modindex') }}">Modules</a></li>
19+
<li>
20+
{% block sidebarsearch %}
21+
{% include "searchbox.html" %}
22+
{% endblock %}
23+
</li>
24+
</ul>
25+
</div>
26+
{% endblock %}
27+
28+
{% block relbar1 %}
29+
<div class="related">
30+
<h3>{{ _('Navigation') }}</h3>
31+
<ul>
32+
{%- if next %}
33+
<li class="right">
34+
<a href="{{ next.link|e }}" title="{{ next.title|striptags|e }}">
35+
next {{ "&raquo;"|safe }}
36+
</a>
37+
</li>
38+
{%- endif %}
39+
{%- if prev %}
40+
<li class="right">
41+
<a href="{{ prev.link|e }}" title="{{ prev.title|striptags|e }}">
42+
{{ "&laquo;"|safe }} previous
43+
</a>
44+
{% if next %}{{ reldelim2 }}{% endif %}
45+
</li>
46+
{%- endif %}
47+
{%- block rootrellink %}
48+
<li>
49+
<a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>
50+
{{ reldelim1 }}
51+
</li>
52+
{%- endblock %}
53+
{%- for parent in parents %}
54+
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
55+
{%- endfor %}
56+
{# Don't put the title in the relbar for the first (index) page. #}
57+
{% if prev %}<li>{{ title }}</li>{% endif %}
58+
{%- block relbaritems %} {% endblock %}
59+
</ul>
60+
</div>
61+
{% endblock %}
62+
63+
{# Silence the bottom relbar. #}
64+
{% block relbar2 %}{% endblock %}
65+
66+
67+
{%- block footer %}
68+
<footer class="footer">
69+
<p class="pull-right">
70+
{%- if edit_on_github %}
71+
<a href="{{ edit_on_github }}">{{ edit_on_github_page_message }}</a> &nbsp;
72+
{%- endif %}
73+
{%- if show_source and has_source and sourcename %}
74+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}"
75+
rel="nofollow">{{ _('Page Source') }}</a>
76+
{%- endif %} &nbsp;
77+
<a href="#">Back to Top</a></p>
78+
<p>
79+
{%- if show_copyright %}
80+
{%- if hasdoc('copyright') %}
81+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}<br/>
82+
{%- else %}
83+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}<br/>
84+
{%- endif %}
85+
{%- endif %}
86+
{%- if show_sphinx %}
87+
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %} &nbsp;
88+
{%- endif %}
89+
{%- if last_updated %}
90+
{% trans last_updated=last_updated|e %}Last built {{ last_updated }}.{% endtrans %} <br/>
91+
{%- endif %}
92+
</p>
93+
</footer>
94+
{%- endblock %}

‎doc/themes/mdolab_theme/localtoc.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<h3>Page Contents</h3>
2+
{{ toc }}
3+

‎doc/themes/mdolab_theme/searchbox.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{%- if pagename != "search" %}
2+
<form action="{{ pathto('search') }}" method="get">
3+
<input type="text" name="q" placeholder="Search" />
4+
<input type="hidden" name="check_keywords" value="yes" />
5+
<input type="hidden" name="area" value="default" />
6+
</form>
7+
{%- endif %}

‎doc/themes/mdolab_theme/static/MDOLAB_text.png

1.41 KB
Loading

0 commit comments

Comments
 (0)