-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adjust app4triqs skeleton for solid_dmft
- Loading branch information
1 parent
701cf08
commit 435126f
Showing
27 changed files
with
68 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
------------- | ||
|
@@ -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 | ||
|
@@ -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`. | ||
|
@@ -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 ### | ||
---------------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.