lattice/sfcf.jl
1
0
Fork 0
mirror of https://igit.ific.uv.es/fernando.p.csic.es/sfcf.jl.git synced 2025-11-30 01:46:52 +01:00
Code Issues Projects Releases Packages Wiki Activity

Readme file

Browse source
This commit is contained in:
Fernando P. Panadero 2024-02-29 12:29:46 +01:00
commit 09f086c07d
1 changed files with 52 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

111
README.md
View file

@ -1,92 +1,83 @@
# sfcf.jl # Readme sfcf.jl
Framework to compute Schrödinger functional correlation functions based on LatticeGPU (https://igit.ific.uv.es/alramos/latticegpu.jl) This is a framework to compute Schrödinger functional correlation functions based on LatticeGPU (https://igit.ific.uv.es/alramos/latticegpu.jl).
## Getting started ## Requirements
To make it easy for you to get started with GitLab, here's a list of recommended next steps. The required packages are listed below
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - LatticeGPU
- CUDA
- TOML
- TimerOutputs
- ArgParse
- InteractiveUtils
- BDIO
- MD5
## Add your files The versions are resolved with the enviroment in the main sfcf.jl directory. The recomended version of julia is julia 1.8.5.
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files ## Input file
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
``` A template for the input file can be found at input/sfcf.in.
cd existing_repo
git remote add origin https://igit.ific.uv.es/fernando.p.csic.es/sfcf.jl.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools * [Space]
- [ ] [Set up project integrations](https://igit.ific.uv.es/fernando.p.csic.es/sfcf.jl/-/settings/integrations) - size : Lattice size. The last component is the time extent.
- blocks : Sub-lattices parallelization on the GPU. Each sub-lattice length must divide each lattice length.
- phi0 : Phases defining the field at the boundary t = 0.
- phiT : Phases defining the field at the boundary t = T.
- cG : Boundary improvement coefficient for the gauge field.
## Collaborate with your team * [Fermion]
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) - beta : Bare coupling.
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) - kappa : Value of the hopping parameter.
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) - theta : Phase for the fermion field in the spatial directions.
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) - csw : Sheikholeslami-Wohlert coefficient
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - ct : Boundary improvement coefficient for the fermion field.
## Test and Deploy * [Solver]
Use the built-in continuous integration in GitLab. - tolerance : Stopping criteria for the solver. The residue of the solver is meassured as the normalized residue for a source given by gamma_5 * D_w * gamma_5 * B , where B is the boundary source for each spin/color.
- maxiter : Maximum number of iterations for the solver.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) ## Configuration input
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
*** Current allowed input formats for the configuration are:
# Editing this README - Native LatticeGPU (default) : Native io format from LatticeGPU
- cern format : Read the format output given the function export_cnfg_cern() in sfqcd (https://gitlab.ift.uam-csic.es/alberto/sfqcd). This is specified with the option --cern
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. ## Execution command
## Suggestions for a good README The available options are:
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name * -c (needed) : Specifies the gauge configuration.
Choose a self-explaining name for your project. * -i (needed) : Specifies the input file.
* --cern : Read the gauge config with cern format
## Description An example of an execution command is
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges $ julia1.8 sfcf.jl -i ./input/sfcf.in -c ./cnfg/randfield
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals note that the main program sfcf.jl assumes that ./ is the main sfcf.jl directory to activate the enviroment.
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation ## Output
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage The main program outputs two files. the name is given by the input file [Run] [name]:
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support * name.log : Log file with differ/ent information about the run
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap * name.bdio : BDIO file with the correlation functions. The BDIO.jl package can be found at https://gitlab.ift.uam-csic.es/alberto/bdio.jl . The structure is the following
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing - Record 1 : Information about the parameters
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - Record 14 : Format ihdr check
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - Record 8 : Gauge config name and MD5 saved as String. Results for the correlation functions, saved in the following order: f_P, f_A, f_1, g_P, g_A, k_V, l_V, k_1, k_T, l_T. All of them are saved as Complex{Float64}
Note that if the BDIO file exists, the results will be appended in Record 8.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.