Skip to content

Commit

Permalink
Adjust app4triqs skeleton for solid_dmft
Browse files Browse the repository at this point in the history
  • Loading branch information
the-hampel committed Apr 26, 2021
1 parent 701cf08 commit 435126f
Show file tree
Hide file tree
Showing 27 changed files with 68 additions and 67 deletions.
2 changes: 1 addition & 1 deletion .clang-tidy
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Checks: '-*,modernize-*,cppcoreguidelines-*,-modernize-use-trailing-return-type'
HeaderFilterRegex: 'app4triqs'
HeaderFilterRegex: 'solid_dmft'
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Please provide the application version that you used.

You can get this information from copy and pasting the output of
```bash
python -c "from app4triqs.version import *; show_version(); show_git_hash();"
python -c "from solid_dmft.version import *; show_version(); show_git_hash();"
```
from the command line. Also, please include the OS you are running and its version.

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ jobs:
make -j1 install VERBOSE=1
cd ../
- name: Build app4triqs
- name: Build solid_dmft
env:
CC: ${{ matrix.cc }}
CXX: ${{ matrix.cxx }}
Expand All @@ -85,7 +85,7 @@ jobs:
mkdir build && cmake -B build
cmake --build build -j2
- name: Test app4triqs
- name: Test solid_dmft
env:
DYLD_FALLBACK_LIBRARY_PATH: /usr/local/opt/llvm/lib
run: |
Expand Down
10 changes: 5 additions & 5 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# ##############################################################################
#
# app4triqs - An example application using triqs and cpp2py
# solid_dmft - An example application using triqs and cpp2py
#
# Copyright (C) ...
#
# app4triqs is free software: you can redistribute it and/or modify it under the
# solid_dmft is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# app4triqs is distributed in the hope that it will be useful, but WITHOUT ANY
# solid_dmft is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# app4triqs (in the file COPYING.txt in this directory). If not, see
# solid_dmft (in the file COPYING.txt in this directory). If not, see
# <http://www.gnu.org/licenses/>.
#
# ##############################################################################
Expand All @@ -30,7 +30,7 @@ endif()

# ############
# Define Project
project(app4triqs VERSION 3.0.0 LANGUAGES C CXX)
project(solid_dmft VERSION 3.0.0 LANGUAGES C CXX)
get_directory_property(IS_SUBPROJECT PARENT_DIRECTORY)

# ############
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# See ../triqs/packaging for other options
FROM flatironinstitute/triqs:unstable-ubuntu-clang
ARG APPNAME=app4triqs
ARG APPNAME=solid_dmft

COPY requirements.txt /src/$APPNAME/requirements.txt
RUN pip3 install -r /src/$APPNAME/requirements.txt
Expand Down
2 changes: 1 addition & 1 deletion Jenkinsfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
def projectName = "app4triqs" /* set to app/repo name */
def projectName = "solid_dmft" /* set to app/repo name */

def dockerName = projectName.toLowerCase();
/* which platform to build documentation on */
Expand Down
8 changes: 4 additions & 4 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
app4triqs - An example application using triqs and cpp2py
solid_dmft - An example application using triqs and cpp2py

Copyright (C) 2017-2018, N. Wentzell, O. Parcollet
Copyright (C) 2018-2019, The Simons Foundation
authors: N. Wentzell, D. Simons, H. Strand, O. Parcollet

app4triqs is free software: you can redistribute it and/or modify it under the
solid_dmft is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

app4triqs is distributed in the hope that it will be useful, but WITHOUT ANY
solid_dmft is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
app4triqs (in the file COPYING.txt in this directory). If not, see
solid_dmft (in the file COPYING.txt in this directory). If not, see
<http://www.gnu.org/licenses/>.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![build](https://github.com/TRIQS/app4triqs/workflows/build/badge.svg)](https://github.com/TRIQS/app4triqs/actions?query=workflow%3Abuild)
[![build](https://github.com/TRIQS/solid_dmft/workflows/build/badge.svg)](https://github.com/TRIQS/solid_dmft/actions?query=workflow%3Abuild)

# app4triqs - A skeleton for a TRIQS application
# solid_dmft - A skeleton for a TRIQS application

Initial Setup
-------------
Expand All @@ -12,11 +12,11 @@ To adapt this skeleton for a new TRIQS application, the following steps are nece
* Run the following commands in order after replacing **appname** accordingly

```bash
git clone https://github.com/triqs/app4triqs --branch python_only appname
git clone https://github.com/triqs/solid_dmft --branch python_only appname
cd appname
./share/squash_history.sh
./share/replace_and_rename.py appname
git add -A && git commit -m "Adjust app4triqs skeleton for appname"
git add -A && git commit -m "Adjust solid_dmft skeleton for appname"
```

You can now add your github repository and push to it
Expand All @@ -30,13 +30,13 @@ git push origin unstable
If you prefer to use the [SSH interface](https://help.github.com/en/articles/connecting-to-github-with-ssh)
to the remote repository, replace the http link with e.g. `[email protected]:username/appname`.

### Merging app4triqs skeleton updates ###
### Merging solid_dmft skeleton updates ###

You can merge future changes to the app4triqs skeleton into your project with the following commands
You can merge future changes to the solid_dmft skeleton into your project with the following commands

```bash
git remote update
git merge app4triqs_remote/python_only -m "Merge latest app4triqs skeleton changes"
git merge solid_dmft_remote/python_only -m "Merge latest solid_dmft skeleton changes"
```

If you should encounter any conflicts resolve them and `git commit`.
Expand All @@ -51,14 +51,14 @@ Getting Started
---------------

After setting up your application as described above you should customize the following files and directories
according to your needs (replace app4triqs in the following by the name of your application)
according to your needs (replace solid_dmft in the following by the name of your application)

* Adjust or remove the `README.md` and `doc/ChangeLog.md` file
* In the `python/app4triqs` subdirectory add your Python source files.
* In the `python/solid_dmft` subdirectory add your Python source files.
* In the `test/python` subdirectory adjust the example test `Basic.py` or add your own tests.
* Adjust any documentation examples given as `*.rst` files in the doc directory.
* Adjust the sphinx configuration in `doc/conf.py.in` as necessary.
* The build and install process is identical to the one outline [here](https://triqs.github.io/app4triqs/unstable/install.html).
* The build and install process is identical to the one outline [here](https://triqs.github.io/solid_dmft/unstable/install.html).

### Optional ###
----------------
Expand Down
4 changes: 2 additions & 2 deletions doc/ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Version 3.0.0
=============

app4triqs version 3.0.0 is a compatibility
solid_dmft version 3.0.0 is a compatibility
release for TRIQS version 3.0.0 that
* introduces compatibility with Python 3 (Python 2 no longer supported)
* adds a cmake-based dependency management
Expand All @@ -11,7 +11,7 @@ release for TRIQS version 3.0.0 that
Version 2.2.0
=============

app4triqs Version 2.2.0 provides a project
solid_dmft Version 2.2.0 provides a project
skeleton for TRIQS applications based on
the TRIQS Library Version 2.2.0.
It is intended for applications with both
Expand Down
2 changes: 1 addition & 1 deletion doc/_templates/sideb.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@
</p>
<hr>
<p>
<a href="https://github.com/triqs/app4triqs"> <img style="width: 200px; margin: 10px 0 0 5px" src='_static/logo_github.png' alt="Visit the project on GitHub"/> </a>
<a href="https://github.com/triqs/solid_dmft"> <img style="width: 200px; margin: 10px 0 0 5px" src='_static/logo_github.png' alt="Visit the project on GitHub"/> </a>
</p>
2 changes: 1 addition & 1 deletion doc/about.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _about:

About app4triqs
About solid_dmft
===============

An example application using ``cpp2py`` and TRIQS.
Expand Down
2 changes: 1 addition & 1 deletion doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
Changelog
=========

This document describes the main changes in APP4TRIQS.
This document describes the main changes in SOLID_DMFT.

.. include:: ChangeLog.md
6 changes: 3 additions & 3 deletions doc/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ Table of Contents
Python reference manual
-----------------------

.. automodule:: app4triqs
.. automodule:: solid_dmft
:members:

.. autoclass:: app4triqs.app4triqs_module.Toto
.. autoclass:: solid_dmft.solid_dmft_module.Toto
:members:

.. autofunction:: app4triqs.app4triqs_module.chain
.. autofunction:: solid_dmft.solid_dmft_module.chain
8 changes: 4 additions & 4 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. _welcome:

app4triqs
solid_dmft
=========

.. sidebar:: app4triqs 2.2.0
.. sidebar:: solid_dmft 2.2.0

This is the homepage of app4triqs v2.2.0.
This is the homepage of solid_dmft v2.2.0.
For changes see the :ref:`changelog page <changelog>`.

An example application using cpp2py and :ref:`TRIQS <triqslibs:welcome>`.

This documentation is generated based on `rst <https://de.wikipedia.org/wiki/ReStructuredText>`_ files
and the comments in the sources and headers.

Learn how to use app4triqs in the :ref:`documentation`.
Learn how to use solid_dmft in the :ref:`documentation`.

.. toctree::
:maxdepth: 2
20 changes: 10 additions & 10 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. _install:

Compiling app4triqs from source
Compiling solid_dmft from source
===============================


Expand All @@ -15,21 +15,21 @@ Prerequisites
Installation steps
------------------

#. Download the source code of the latest stable version by cloning the ``TRIQS/app4triqs`` repository from GitHub::
#. Download the source code of the latest stable version by cloning the ``TRIQS/solid_dmft`` repository from GitHub::

$ git clone https://github.com/TRIQS/app4triqs app4triqs.src
$ git clone https://github.com/TRIQS/solid_dmft solid_dmft.src

#. Create and move to a new directory where you will compile the code::

$ mkdir app4triqs.build && cd app4triqs.build
$ mkdir solid_dmft.build && cd solid_dmft.build

#. Ensure that your shell contains the TRIQS environment variables by sourcing the ``triqsvars.sh`` file from your TRIQS installation::

$ source path_to_triqs/share/triqs/triqsvars.sh

#. In the build directory call cmake, including any additional custom CMake options, see below::

$ cmake ../app4triqs.src
$ cmake ../solid_dmft.src

#. Compile the code, run the tests and install the application::

Expand All @@ -39,12 +39,12 @@ Installation steps
Version compatibility
---------------------

Keep in mind that the version of ``app4triqs`` must be compatible with your TRIQS library version,
Keep in mind that the version of ``solid_dmft`` must be compatible with your TRIQS library version,
see :ref:`TRIQS website <triqslibs:versions>`.
In particular the Major and Minor Version numbers have to be the same.
To use a particular version, go into the directory with the sources, and look at all available versions::

$ cd app4triqs.src && git tag
$ cd solid_dmft.src && git tag

Checkout the version of the code that you want::

Expand All @@ -55,14 +55,14 @@ and follow steps 2 to 4 above to compile the code.
Custom CMake options
--------------------

The compilation of ``app4triqs`` can be configured using CMake-options::
The compilation of ``solid_dmft`` can be configured using CMake-options::

cmake ../app4triqs.src -DOPTION1=value1 -DOPTION2=value2 ...
cmake ../solid_dmft.src -DOPTION1=value1 -DOPTION2=value2 ...

+-----------------------------------------------------------------+-----------------------------------------------+
| Options | Syntax |
+=================================================================+===============================================+
| Specify an installation path other than path_to_triqs | -DCMAKE_INSTALL_PREFIX=path_to_app4triqs |
| Specify an installation path other than path_to_triqs | -DCMAKE_INSTALL_PREFIX=path_to_solid_dmft |
+-----------------------------------------------------------------+-----------------------------------------------+
| Build in Debugging Mode | -DCMAKE_BUILD_TYPE=Debug |
+-----------------------------------------------------------------+-----------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion doc/issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Reporting issues
================

Please report all problems and bugs directly at the github issue page
`<https://github.com/TRIQS/app4triqs/issues>`_. In order to make it easier for us
`<https://github.com/TRIQS/solid_dmft/issues>`_. In order to make it easier for us
to solve the issue please follow these guidelines:

#. In all cases specify which version of the application you are using. You can
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
easyblock = 'CMakeMake'

name = 'TRIQS-app4triqs'
name = 'TRIQS-solid_dmft'
version = '3.0.0'
versionsuffix = '-Python-%(pyver)s'

homepage = 'https://triqs.github.io/app4triqs/'
homepage = 'https://triqs.github.io/solid_dmft/'
description = """
TRIQS (Toolbox for Research on Interacting Quantum Systems) is a
scientific project providing a set of C++ and Python libraries to
Expand All @@ -13,14 +13,14 @@ description = """
PROVIDE HERE A DESCRIPTION OF YOUR APPLICATION
"""

docurls = ['https://triqs.github.io/app4triqs/%(version_major_minor)s.x/']
docurls = ['https://triqs.github.io/solid_dmft/%(version_major_minor)s.x/']
software_license = 'LicenseGPLv3'

toolchain = {'name': 'foss', 'version': '2019a'}
toolchainopts = {'pic': True, 'usempi': True}

source_urls = ['https://github.com/TRIQS/app4triqs/releases/download/%(version)s/']
sources = ['app4triqs-%(version)s.tar.gz']
source_urls = ['https://github.com/TRIQS/solid_dmft/releases/download/%(version)s/']
sources = ['solid_dmft-%(version)s.tar.gz']
checksums = ['PUT HERE THE SHA256 OF THE RELEASE TARBALL']

dependencies = [
Expand All @@ -45,21 +45,21 @@ separate_build_dir = True
runtest = 'test'

sanity_check_paths = {
'files': ['lib/libapp4triqs_c.a'],
'dirs': ['include/app4triqs', 'lib', 'share',
'lib/python%(pyshortver)s/site-packages/app4triqs'],
'files': ['lib/libsolid_dmft_c.a'],
'dirs': ['include/solid_dmft', 'lib', 'share',
'lib/python%(pyshortver)s/site-packages/solid_dmft'],
}

sanity_check_commands = ["python -c 'import app4triqs'"]
sanity_check_commands = ["python -c 'import solid_dmft'"]

modextrapaths = {
'CPLUS_INCLUDE_PATH': 'include',
'PYTHONPATH': 'lib/python%(pyshortver)s/site-packages',
'CMAKE_PREFIX_PATH': 'lib/cmake/app4triqs',
'CMAKE_PREFIX_PATH': 'lib/cmake/solid_dmft',
}
modextravars = {
'APP4TRIQS_ROOT': '%(installdir)s',
'APP4TRIQS_VERSION': '%(version)s',
'SOLID_DMFT_ROOT': '%(installdir)s',
'SOLID_DMFT_VERSION': '%(version)s',
}

moduleclass = 'phys'
Loading

0 comments on commit 435126f

Please sign in to comment.