search

architecture-building-systems / umem-jbps-data

Final Journal Publication for A/S UMEM
3 stars 1 forks source link

Can we keep the CitySim executables in the repository? #12

Open daren-thomas opened 8 years ago

daren-thomas commented 8 years ago

Currently there is a version of CitySim.exe and CitySimd.exe in the repository (folder /citysim) and the workflows are set up to use these.

I am not sure if this is congruent with the citysim license. Jerome, can you check and advise? We can purge the binaries from the repo if required!

jkaempf commented 8 years ago

The only problem with CitySim Solver remains in the licence contract from EPFL. Indeed EPFL wants the user to acknoledge the fact that EPFL will not take responsibility of potentially wrong results (in order to avoid law suits, etc.). Therefore, the people need to accept some conditions on citysim.epfl.ch in order to download the two executables. To make short a long story, either you have a licence for the workflow which clearly states "use at your own risk" and you point to the website citysim.epfl.ch for the conditions of use of CitySim Solver.. Or you remove the binairies from the repo and put just a link to the webpage citysim.epfl.ch where people can download the latest version accepting the user's agreement. Let me know how you want to proceed :)

daren-thomas commented 8 years ago

If placing a license file in the citysim directory (and maybe a notice in the LICENSE.md file at root) would be sufficient, then I'd prefer to keep the executables in the repository. That way, the whole code for the paper, including workflows and dependencies is stored there.

except, the design-performance-workflows is separate... oh, and so is vistrails... hm... but... well, those are external to the workflows: if you deploy the workflows with dependencies outside the root of the repository, then you need to figure out how to refer to the binaries... know what i mean?

Can you provide such a license?

On Fri, Feb 5, 2016 at 11:41 AM, Jerome Kaempf notifications@github.com wrote:

The only problem with CitySim Solver remains in the licence contract from EPFL. Indeed EPFL wants the user to acknoledge the fact that EPFL will not take responsibility of potentially wrong results (in order to avoid law suits, etc.). Therefore, the people need to accept some conditions on citysim.epfl.ch in order to download the two executables. To make short a long story, either you have a licence for the workflow which clearly states "use at your own risk" and you point to the website citysim.epfl.ch for the conditions of use of CitySim Solver.. Or you remove the binairies from the repo and put just a link to the webpage citysim.epfl.ch where people can download the latest version accepting the user's agreement. Let me know how you want to proceed :)

— Reply to this email directly or view it on GitHub https://github.com/architecture-building-systems/UMEM-JBPS-Paper/issues/12#issuecomment-180289571 .

jkaempf commented 8 years ago

Sure.. you can have a look at citysim.epfl.ch. It states that:

By using the software CitySim Solver from LESO-PB/EPFL you confirm your acceptance of the following conditions :

daren-thomas commented 8 years ago

cool! funny: i need just such a license for another project!

On Friday, 5 February 2016, Jerome Kaempf notifications@github.com wrote:

Sure.. you can have a look at citysim.epfl.ch. It states that:

By using the software CitySim Solver from LESO-PB/EPFL you confirm your acceptance of the following conditions :

  • The software will be provided "as is"; no modification will be undertaken by LESO-PB/EPFL.
  • Your institute will not claim rights in any patents and/or trademarks on the software received from LESO-PB/EPFL.
  • LESO-PB/EPFL will not be held responsible for any consequence of the use of the software.
  • Your institute will acknowledge the use of the software and its origin at LESO-PB/EPFL in all publications and presentations in accordance with customary academic practice.

— Reply to this email directly or view it on GitHub https://github.com/architecture-building-systems/UMEM-JBPS-Paper/issues/12#issuecomment-180351384 .

daren-thomas commented 8 years ago

Jerome,

I will remove the binaries from the repository and place information on how to download the files.

I got a letter from GitHub saying that LFS (large file storage) has been deactivated because, well, we were using too much. This has to do with the binaries but also with the results. I have yet to figure out how to publish the results - maybe with polybox? I'll ask the IT guys...

Best, Daren

On Sun, Feb 7, 2016 at 4:13 PM, Daren Thomas dthomas.ch@gmail.com wrote:

cool! funny: i need just such a license for another project!

On Friday, 5 February 2016, Jerome Kaempf notifications@github.com wrote:

Sure.. you can have a look at citysim.epfl.ch. It states that:

By using the software CitySim Solver from LESO-PB/EPFL you confirm your acceptance of the following conditions :

  • The software will be provided "as is"; no modification will be undertaken by LESO-PB/EPFL.
  • Your institute will not claim rights in any patents and/or trademarks on the software received from LESO-PB/EPFL.
  • LESO-PB/EPFL will not be held responsible for any consequence of the use of the software.
  • Your institute will acknowledge the use of the software and its origin at LESO-PB/EPFL in all publications and presentations in accordance with customary academic practice.

— Reply to this email directly or view it on GitHub https://github.com/architecture-building-systems/UMEM-JBPS-Paper/issues/12#issuecomment-180351384 .

jkaempf commented 8 years ago

Hey Daren,

So finally you give up with the license? ;) Why?

Oh! Kicked out of LFS! I will try this afternoon to (re-)start the co-sim for the EPFL part :)

daren-thomas commented 8 years ago

Right. I think I'll buy some LFS data plan because I really like having the data in the repository. But I'm ok with providing the binaries separately (also for EnergyPlus). I am trying to find a good way to do these kind of projects, you know, with the workflows etc. To have projects that can kind of document themselves, the steps taken etc. This is a personal side goal for the paper.

On Mon, Feb 8, 2016 at 11:15 AM, Jerome Kaempf notifications@github.com wrote:

Hey Daren,

So finally you give up with the license? ;) Why?

Oh! Kicked out of LFS! I will try this afternoon to (re-)start the co-sim for the EPFL part :)

— Reply to this email directly or view it on GitHub https://github.com/architecture-building-systems/UMEM-JBPS-Paper/issues/12#issuecomment-181291158 .

jkaempf commented 8 years ago

I perfectly understand you personal side goal :)