QuantumPlasmas-IST / TETHYS-Graphene-Hydrodynamic-Simulation

Hydrodynamic simulation of plasmons in graphene
MIT License
6 stars 0 forks source link

Getting ready for deployment #52

Closed pcosme closed 3 years ago

pcosme commented 3 years ago

Hey there 👋

We should start thinking about opening this repository to public so that we can reference it on our scientific publications (and also to see if we get some attention of course) it will also unlock more features here on github. I'm confident that probably before Christmas we will be able to have a stable code to do so.

With that in mind we should start to think on

pcosme commented 3 years ago

At commit 6d1f0864e377006955745f23173e07b19abeaad1 I've changed the CMakeLists.txt (and also the file tree) so that the libraries are now properly linked as static libraries. :warning: Therefore, if you change the libraries itself you now need to recompile the libraries separately and prior to the compilation of the sources

pcosme commented 3 years ago

I'll also be adding a license to the software. After reeding some licenses and discussing the issue also with my brother I think I'll just use (for now at least) MIT license

pcosme commented 3 years ago

At commit a85b5e721b107ef8929714f50ff4144412870a51 automatic testing runs were included on the cmake via CMakeLists.txt

pcosme commented 3 years ago

I've changed the repository visibility to public :heart:

pcosme commented 3 years ago

I have minted the doi trough zenodo to make our code citable.

DOI: 10.5281/zenodo.4319282

With the citation

@software{pedro_cosme_2020_4319282,
  author       = {Pedro Cosme and
                  João Santos},
  title        = {{TETHYS - Two-dimensional Emitter of THz, 
                   Hydrodynamic Simulation.}},
  month        = dec,
  year         = 2020,
  note         = {{The author P. Cosme acknowledges the funding 
                   provided by FCT-Portugal through the Grant Number
                   PD/BD/150415/2019}},
  publisher    = {Zenodo},
  version      = {v.2.3.1-beta},
  doi          = {10.5281/zenodo.4319282},
  url          = {https://doi.org/10.5281/zenodo.4319282}
}