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

Add notes regarding conan and Build Tools Visual Studio 2022 #47

Merged

Conversation

StephanieKemna
Copy link
Collaborator

Resolves #35 : added 2 notes regarding install of Build Tools for VS 2022.

@StephanieKemna StephanieKemna linked an issue Jul 16, 2024 that may be closed by this pull request
@StephanieKemna StephanieKemna added the documentation Improvements or additions to documentation label Jul 16, 2024
Copy link
Collaborator

@KristofferSkare KristofferSkare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Just wondering about some formatting

README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -180,6 +180,10 @@ For advanced usage options, e.g. editing the generated FMU source code, or using

_Hint:_ If you are unsure which cuda version to indicate in above `pip install .. /cuXXX` command, you can use the shell command `nvidia-smi` on your local system to find out the cuda version supported by the current graphics driver installed on your system. When then generating the `pip install` command with the wizard from the [PyTorch website](https://pytorch.org/get-started/locally/), select the cuda version that matches the major version of what your graphics driver supports (major version must match, minor version may deviate).

> Note: We use conan for building the FMU. For the conan building to work later on, you will need the Visual Studio Build tools 2022 to be installed. It is best to do this **before** installing conan (which we install via pip install of requirements). You can download and install the Build Tools for VS 2022 (for free) from <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to make this link look nicer?

If so we can replace <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022> with [Some text here](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about it, but from a cybersecurity perspective, this is just as good, and then folks know where it comes from / where to navigate to (in case the url changes). It is not the ugliest URL with lots of redirects and things.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use this type of URL other places in the README as well then?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. As long as URLs are not crazy, I would just show the full one. What do you think?
And @Jorgelmh ?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I guess it's safer to show the full URL

@StephanieKemna StephanieKemna self-assigned this Jul 22, 2024
Copy link
Collaborator

@Jorgelmh Jorgelmh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@StephanieKemna StephanieKemna merged commit dc5b15e into main Jul 22, 2024
11 checks passed
@StephanieKemna StephanieKemna deleted the 35-add-documentation-for-installing-c++-compiler-and-cmake branch November 8, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for installing C++ compiler and cmake
3 participants