Skip to content

Commit 0c0cf67

Browse files
authored
Added info to setup.py for PyPI (#388)
1 parent caa1e21 commit 0c0cf67

2 files changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ OpenAeroStruct
44
![GitHub Actions Status](https://github.com/mdolab/OpenAeroStruct/workflows/OAS%20build/badge.svg)
55
[![codecov](https://codecov.io/gh/mdolab/OpenAeroStruct/branch/main/graph/badge.svg?token=yOxeH7rT2H)](https://codecov.io/gh/mdolab/OpenAeroStruct)
66
[![Documentation Status](https://readthedocs.com/projects/mdolab-openaerostruct/badge/?version=latest)](https://mdolab-openaerostruct.readthedocs-hosted.com/en/latest/?badge=latest)
7-
[![PyPI](https://img.shields.io/pypi/v/openaerostruct)](https://pypi.org/project/OpenAeroStruct/)
8-
![PyPI - Downloads](https://img.shields.io/pypi/dm/OpenAeroStruct)
7+
[![PyPI](https://img.shields.io/pypi/v/openaerostruct)](https://pypi.org/project/openaerostruct/)
8+
[![PyPI - Downloads](https://img.shields.io/pypi/dm/openaerostruct)](https://pypi.org/project/openaerostruct/)
99

1010
OpenAeroStruct is a lightweight tool that performs aerostructural optimization using OpenMDAO.
1111
It couples a vortex-lattice method (VLM) and a 6 degrees of freedom 3-dimensional spatial beam model to simulate aerodynamic and structural analyses using lifting surfaces.
1212
These simulations are wrapped with an optimizer using NASA's OpenMDAO framework.
1313
The analysis and optimization results can be visualized using included tools, producing figures such as these:
1414

1515
*With a tubular structure*
16-
![Example](openaerostruct/docs/figures/example.png)
16+
![Example](https://raw.githubusercontent.com/mdolab/OpenAeroStruct/main/openaerostruct/docs/figures/example.png)
1717

1818
*With a wingbox structure*
19-
![Example2](openaerostruct/docs/figures/wingbox_fine.png)
19+
![Example2](https://raw.githubusercontent.com/mdolab/OpenAeroStruct/main/openaerostruct/docs/figures/wingbox_fine.png)
2020

2121
Please note that this repository is provided as is without any guaranteed support.
2222
If you would like to highlight issues, ask questions, or make changes, please do so using GitHub Issues and Pull Requests.

setup.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
from setuptools import setup
22

33
import re
4+
import os
45

56
__version__ = re.findall(
67
r"""__version__ = ["']+([0-9\.]*)["']+""",
@@ -17,10 +18,20 @@
1718
[dependency for dependencies in optional_dependencies.values() for dependency in dependencies]
1819
)
1920

21+
this_directory = os.path.abspath(os.path.dirname(__file__))
22+
with open(os.path.join(this_directory, "README.md"), encoding="utf-8") as f:
23+
long_description = f.read()
24+
2025
setup(
2126
name="openaerostruct",
2227
version=__version__,
2328
description="OpenAeroStruct",
29+
long_description=long_description,
30+
long_description_content_type="text/markdown",
31+
url="https://github.com/mdolab/OpenAeroStruct",
32+
keywords="",
33+
author="",
34+
author_email="",
2435
license="BSD-3",
2536
packages=[
2637
"openaerostruct",

0 commit comments

Comments
 (0)