Skip to content

Conversation

@hpohekar
Copy link
Collaborator

@hpohekar hpohekar commented Sep 21, 2023

Updated installation section.

image

@raph-luc
Copy link
Member

Wouldn't this additional/specific information be more appropriate in https://fluent.docs.pyansys.com/version/stable/getting_started/installation.html ?

I think the main GitHub readme should probably tend towards being leaner and only containing necessary or basic information

In fact, should we also remove the whole "for developers" section from the main GitHub readme, as it is rather specific? We already have a "for developers" section in the installation page I mentioned above, that is probably a more appropriate location for this information.

@mkundu1
Copy link
Contributor

mkundu1 commented Sep 21, 2023

pip install git+https://github.com/ansys/pyfluent.git will pull the files from git main branch and compile the package from them. The installed package won't have the generated files from codegen, so we should not recommend it for non-developers.

I'd avoid recommending pip install git+https://github.com/ansys/pyfluent.git in general. For developers, starting from a git clone is quite standard.

@hpohekar hpohekar merged commit e28c279 into main Sep 27, 2023
@hpohekar hpohekar deleted the doc/update_readme_installation_steps branch September 27, 2023 03:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Possibly relegate development instructions in readme other ideas

6 participants