Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make preCICE config file used for solverdummy follow the tutorials naming convention #172

Open
IshaanDesai opened this issue Mar 6, 2023 · 5 comments
Labels
good first issue Good for newcomers

Comments

@IshaanDesai
Copy link
Member

Similar to precice/precice#1454

The precice-config file: https://github.com/precice/python-bindings/blob/develop/examples/solverdummy/precice-config.xml does not follow the naming conventions set in https://precice.org/community-contribute-to-precice.html#naming-conventions.

@IshaanDesai IshaanDesai added the good first issue Good for newcomers label Mar 6, 2023
@phershbe
Copy link

phershbe commented Mar 6, 2023

Hello Ishaan, I'd like to work on this if possible. It doesn't seem too hard, and the guidance from the other pull request helps. Thank you.

@IshaanDesai
Copy link
Member Author

@phershbe sure, please fork the repo and open a pull request to the develop branch when you have done the changes. As you have correctly noted, the changes are straightforward and the pull request mentioned above is a very good reference.

@phershbe
Copy link

phershbe commented Mar 9, 2023

Thank you, I'm going to work on it today. I was a little bit behind because I've been traveling. Where I'm at is that I've downloaded the dependencies on Homebrew and I think next is to do the build. I also noticed that the previous pull request had had some difficulties in that part. It was going fine for me but then I was busy with other stuff. I'll get it in later today or send an update.

@phershbe
Copy link

Hello @IshaanDesai, an update ... I got behind on this, I'm getting things going though. I think I've cleared up some of my confusion now because the other example mentioned, precice/precice#1548, is regarding https://github.com/precice/precice and this is regarding https://github.com/precice/python-bindings, correct? (Not your fault, as I'm new I got confused though.) So I followed https://precice.org/installation-source-preparation.html and got everything built and the tests passing, but then I realized that I was in the wrong repository.

Now I need to follow https://precice.org/installation-bindings-python.html I think. So I'm going to work on this later today. I think for somebody new to the project and this specific issue, building and testing everything is most of the task and updating the names and making sure the tests correspond should be relatively fast. Let me know if there is anything that I understand incorrectly above or if you have anything to add. Thank you.

@IshaanDesai
Copy link
Member Author

think I've cleared up some of my confusion now because the other example mentioned, precice/precice#1548, is regarding https://github.com/precice/precice and this is regarding https://github.com/precice/python-bindings, correct?

Correct. precice/precice is the repository of the coupling library preCICE, and precice/python-bindings is the repository of the Python bindings of the preCICE API.

To run and test things locally, you need to install preCICE itself, and then the Python bindings on top of it. So you have actually followed the procedure correctly.

@IshaanDesai IshaanDesai added this to the precice: Version 3.0.0 milestone Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants