su2code.github.io/develop.html at master · rsanfer/su2code.github.io

History

344 lines (262 loc) · 19.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>SU2, the open-source CFD code</title>

</head>

</div>

</div>

SU2 Developers

</h1></div>

<p>

The SU2 community has reached a critical mass, and we're now seeing contributions from all over the world. It's time to tap into our collective expertise, creativity, and coding abilities to take SU2 to the next level. We invite everyone to join the official developer team by first subscribing to the developer email list:

</p>

<br>

<p>

Join the Dev List!</a></center>

</p>

<br>

<p>Join the discussion to be a part of the development campaign for SU2. This is a completely open, archived email list that the entire development team can use for the following: </p>

<br>

<ul>

<li> Help shape the future direction of the SU2 suite.</li>

<li> Meet other developers and collaborate.</li>

<li> Share ideas, innovations, and results.</li>

<li> Receive recognition for contributions.</li>

</ul>

<br>

<p>SU2 is being developed by individuals and organized teams around the world. Currently, the most active teams contributing to SU2 are:</p>

<br>

<ul>

<li><a href="teams/SU_Team.html">Team at Stanford University.</a></li>

<li><a href="teams/TD_Team.html">Team at Delft University of Technology.</a></li>

<li><a href="teams/KL_Team.html">Team at Kaiserslautern University of Technology.</a></li>

<li><a href="teams/IC_Team.html">Team at Imperial College.</a></li>

<li><a href="teams/USB_Team.html">Team at the University of Basilicata.</a></li>

<li><a href="teams/PM_Team.html">Team at Polytechnic University of Milan.</a></li>

<li><a href="teams/UB_Team.html">Team at University of Brescia.</a></li>

<li><a href="teams/US_Team.html">Team at University of Strathclyde.</a></li>

<li>Team at University of Twente.</li>

<li>Team at the University of Michigan.</li>

<li>Team at Queen's University.</li>

<li>Team at Royal Military College of Canada.</li>

<li>Team at the Indian Institute of Technology Gandhinagar.</li>

<li>Team at the University of Sydney.</li>

<li>Team at Virginia Tech.</li>

</ul>

<br>

<p><b>Note I: If you are actively working on SU2 and your team is not in the list, please let us know and we will add your team and profile to this webpage</a>.</b></p>

<p></p>

<br>

<p> Developers on the email list are encouraged to share their development initiatives in SU2, to get involved with the organization of SU2 events, and to share their opinions about the future direction for the SU2 project in general. As detailed below, we also encourage all developers on the list to create accounts and interface with the SU2 project on GitHub.</p>

<p><b>Note II: questions or issues concerning the use of SU2 should be directed to the <a href="http://www.cfd-online.com/Forums/su2/">CFD Online forum for SU2</a>.</b></p>

<br>

<!--

<p>

In addition, we're now opening up the developer meetings in order to deliver important content to the SU2 community. A significant portion of upcoming meetings will cover two new features: a spotlight discussion of a relevant SU2 topic led by one of the developers, as well as a Q & A session during which the development team will answer pressing forum questions. Folks are encouraged to submit their questions and topics ahead of the meetings for inclusion on the <a href="http://www.cfd-online.com/Forums/su2">SU2 CFD Online forum</a>. Join us on Wednesdays at 10 am PDT for live broadcasts on YouTube:

</p>

<br>

<p>

SU2 on YouTube!

</a></center>

</p>

-->

<h4>Gitting Started</h4>

<p> GitHub is the center of all development efforts in SU2. The su2code GitHub organization contains the <a href="https://github.com/su2code/SU2">main code</a> repository as well as supporting materials:</p>

<br>

SU2 on Github!</a>

</center></p>

<br>

<p>You can check out all of the development activity, and new developers are encouraged to log feature requests, questions, and bug reports through the GitHub <a href="https://github.com/su2code/SU2/issues">issue tracker</a>. Developers can have their code contributions integrated through GitHub as well. For more information, look at the <a href="https://github.com/su2code/SU2/wiki">SU2 wiki</a> on GitHub. </p>

<!--

<h4>Branching Model</h4>

<p> This list describes the three types of branches on the SU2 repository. You'll want to pick the right one to work with, in order keep the merging process simple.</p>

<ul>

<li> master -- stable, latest release and fixes </li>

<li> develop -- current development, generally the branch for you to start with </li>

<li> feature-* -- feature specific branches, check with the developer email list if you think this a better place to contribute </li>

</ul>

<h4>Contributing Code</h4>

<p> SU2 merges new code contributions through <a href="https://help.github.com/articles/creating-a-pull-request">pull requests</a>. As a new developer, you'll want to <a href="https://help.github.com/articles/fork-a-repo/">fork</a> SU2 to your personal account. This creates a clone of the whole SU2 repository, branches and all, inside your github account. Generally you'll want to start from the develop branch, but you can check with the dev-list if you think it would be more appropriate to work on a feature branch. </p>

<p> You can push all of your working changes to your forked repository. Once you're happy with these, and want to push them to the origin repository, submit a pull request for your branch. Make sure to pull any new changes from the origin repository before submitting the pull request, so that the changes can be merged more simply. The senior developers will check out the changes, make comments, ask for some edits. Then when everything looks good, your changes will merge into the main development branch! </p>

-->

<!--

<h4>Developer Materials</h4>

<h5>SU2-Pointwise joint workshop. September 29-30, 2014 (SU2 ver. 3.2.2)</h5>

<ul>

<li> <a href="https://github.com/su2code/Documentation/tree/master/Presentations/3rd%20Workshop">Webinar Presentation Slides [GitHub]</a> </li>

<li> <a href="http://www.youtube.com/channel/UCxv_00gWLAQPBUnl9mGRQjA">Webinar Recording (s) [YouTube]</a> </li>

<li> <a href="http://su2.stanford.edu/develop/code_intro.html">High-Level Source Code Overview</a> </li>

<li> <a href="http://su2.stanford.edu/develop/call_graph.html">Program Call Structure</a> </li>

<li> <a href="https://github.com/su2code/SU2/wiki/Coding+style+guidelines">SU2 Style Guide</a> </li>

</ul>

-->

<!--

<h4>We want you to improve SU2!</h4>

<div class="bio_img"> <img class="framed_img"

src="images/photo/Uncle-Sam.jpg" alt="SU2 wants you!" width="158px" height="213px"/>

</div>

<p> SU2 is now in prime position for the next major wave of development, and we want it to include contributions from developers all over the globe. Simply put, we want your help in adding new features to your favorite open-source CFD suite! </p>

<p> Below, you will find information regarding some important contributions that we believe are ripe for implementation in SU2 with a little help from the open-source community. We want to hear from any developers out there with an interest in tackling these topics or others (innovative ideas encouraged)!</p>

<h3> 1) A Graphical User Interface (GUI) for SU2 </h3>

<p>With so many available options, setting up a configuration file

can sometimes be an obstacle to your analysis. SU2 would

benefit significantly from a graphical

interface to ease the creation and manipulation of

configuration files. Some

requested features for a GUI are:</p>

<ul>

<li>Minimal use of external libraries (easy to

install).</li>

<li>Attractive, intuitive, and discoverable visual

design.</li>

<li>Easily adaptable to changes in the configuration file

format or options.</li>

</ul>

<h3> 2) Expanded Support for the CGNS Standard</h3>

<p>We believe that open data formats are important, and with that in

mind, we would like to further expand our support for the

<a href="http://cgns.sourceforge.net"> CFD General Notation System (CGNS)

Standard</a>. The current version of SU2 accepts CGNS

unstructured, single-block meshes for input, and CGNS

output is also supported, although these features could

be expanded. For example, the current

implementation generates a new file for output rather

than writing solution data into the original CGNS input

file. This would reduce disk storage, improve

performance, and also make it easier to

interface SU2 with other pre- and

post-processors. Some ideas might be: </p>

<ul>

<li>Implement an HDF5 based CGNS reader/writer.</li>

<li>Add full support for mixed-element and multi-zone unstructured meshes.</li>

<li>Streamline file I/O by reusing the original mesh file for solution output.</li>

</ul>

<h3>3) Extended Documentation</h3>

<p>Clear documentation is one of the most important features of the code,

and it provides the fastest way to get up to speed with SU2.

We would like your help improving the general documentation of

SU2. In particular, we would appreciate contributions

in the following areas:</p>

<ul>

<li>Expanded tutorials: we would like additional tutorials that complement the existing set found in the web-based documentation. The tutorials can either detail and explain the functionality of SU2 (shape optimization, parallel computing, mesh deformation, etc.) or demonstrate general CFD knowledge (highlighting good meshes vs. bad meshes, the importance of CFL number, etc.). Tutorials are intended to be tools for teaching and learning, and they should follow the same style as the existing tutorials. They must provide any mesh or config files that are necessary for their completion. New or unique verification and validation cases would be of particular interest here. </li>

<li>Source code: help us increase the legibility of the SU2 source code either by providing further comments within the code or by highlighting code portions that are unclear. Specific additional comments (or wording changes) should be sent to us via GitHub pull requests. Those wishing to make requests for added clarity in particular source locations can use the github issue tracker. Please be specific on comment requests.</li>

</ul>

<h3>4) Additional Ideas</h3>

<ul>

<li>Memory layout optimization</li>

<li>Binary versions for mesh/restart files</li>

<li>Additional turbulence models</li>

<li>Interfaces to PETSC or other linear solvers</li>

<li>OpenMP implementation (within the linear solver only)</li>

<li>Code performance profiling/optimization</li>

<li>Python wrapping</li>

<li>Posing open-source analysis and design problems</li>

<li>Sharing test cases and/or meshes</li>

<li>Your own great idea?</li>

</ul>

-->

</div>

</div></div>

</div>

</div>

</div>

</div>

</div>

var _gaq = _gaq || [];

_gaq.push(['_setAccount', 'UA-28187985-1']);

_gaq.push(['_trackPageview']);

(function() {

var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

})();

</script>

var _gaq = _gaq || [];

_gaq.push(['_setAccount', 'UA-35193029-1']);

_gaq.push(['_trackPageview']);

(function() {

var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

})();

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

develop.html

Latest commit

History

develop.html

File metadata and controls